Run care analytics report

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Details

Runs a Care Analytics report where report_type is one of the following:

  • author (Raw Author Export)
  • combined (Raw Combined Export)
  • conversation (Raw Conversations)
  • conversation_actions (Conversation Actions Export) - Added July 2019
  • incoming_post (Raw Incoming Post Export)
  • raw_agent_states (Agent State Export) - Added December 2018
  • raw_expert_help (Raw Help Request Export) - Added March 2017
  • response (Raw Response Export)
  • response_approval (Raw Response Approval)
  • team_performance (Raw Team Performance)
  • team_performance_interval (Team Performance Interval)
🚧

Important

You may also generate a Conversation Actions Export report. See POST /reports/report/conversation_actions and GET /reports/report/conversation_actions.

All arguments are case-sensitive.

Note the workflowId and the runId in the response. These are unique IDs specific to this report job. You will use these IDs to check the status of a job and to download the report output.

See Using timezone with timezoneOffset when making a request with these parameters.

Path Params
string
required
Query Params
string
required
string
Defaults to OPEN_AT_END
string
required
string
Defaults to false
string
string
string
Defaults to json
string
string
string
required
string
string
string
string
string
Headers
string
enum
Defaults to application/json
Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
text/plain
application/json