Reporting
Fetch record reporting data
Reporting
Fetch record reporting data
Retrieves record reporting data. A record report holds your compensation’s data, consolidated around metrics on a record level.
GET
/
v1
/
reporting
/
{data_table_key}
/
records
Pagination
This endpoint is paginated using parameters offset and limit The “next” key in the response allow you to easily follow pagination to get the next batch of users
Variable api keys
This endpoint is based on dynamic fields. This mean that all annotations
that look like <variable-key>, will have to or will be replaced by their
actual API keys.
Authorizations
X-API-Key
string
headerrequiredPath Parameters
data_table_key
string
requiredUsed to identify the data table
Query Parameters
offset
integer
default: 0Optional (minimum:0 - maximum:9223372036854775807)
Required range:
0 < x < 9223372036854776000limit
integer
default: 200Optional (minimum:0 - maximum:200): if set to 0 return total count only
Required range:
0 < x < 200Response
200 - application/json
count
integer
requiredNumber of records in the response
data
object[]
requirednext
string
Next page of the response
Was this page helpful?