Vixiees API

Sections

Theme switcher

Retrieves sales dashboard performance data for a single agent

Header Parameters

X-Api-Keystring

Query Parameters

playbook_idstring Required

ID of the playbook to filter by

user_idstring Required

ID of the agent whose performance to return

periodstring Required

Time period (e.g. this_week, this_month, last_week, last_month, last_two_months, last_7_days, last_14_days, last_30_days, custom)

start_datestring

Start date for custom period (ISO 8601)

end_datestring

End date for custom period (ISO 8601)

Response

200
Object

performance data returned

Response Attributes

kpisarray

Show child attributes

chartarray

Show child attributes

401
Object

unauthorized

404
Object

playbook or user not found

422
Object

date range exceeds limit

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?