impectR (version 2.5.3)

getMatches: Return a dataframe with basic information for all matches for a given iteration ID

Description

Return a dataframe with basic information for all matches for a given iteration ID

Usage

getMatches(iteration, token, host = "https://api.impect.com")

Value

a dataframe containing all matches for a given iteration ID

Arguments

iteration

'IMPECT' iteration ID

token

bearer token

host

host environment

Examples

# Toy example: this will error quickly (no API token)
try(matchplan <- getMatches(
  iteration = 0,
  token = "invalid"
))

# Real usage: requires valid Bearer Token from `getAccessToken()`
if (FALSE) {
matchplan <- getMatches(
  iteration = 1004,
  token = "yourToken"
)
}