getMatches: Return a dataframe with basic information for all matches for...

In impectR: Access Data from the 'Impect' API

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")

Arguments

iteration	'IMPECT' iteration ID
token	bearer token
host	host environment

Value

a dataframe containing all matches for a given iteration ID

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()`
## Not run: 
matchplan <- getMatches(
  iteration = 1004,
  token = "yourToken"
)

## End(Not run)

impectR documentation built on Dec. 17, 2025, 5:09 p.m.