POST /api/v2/scorecards/export

Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /scorecards/export/{request_id}.

Scorecards for the whole company will be processed by default. A target_id and target_type can be provided to limit the stats to a single target.

Added on Feb 12, 2024 for API v2.

Rate limit: 250 per minute.

Servers

https://dialpad.com/
https://sandbox.dialpad.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`timezone`	Null	No	Timezone using a tz database name. Default value: "UTC"
`graded_days_ago_end`	Integer	No	End of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded_days_ago_start to specify a range.
`scorecard_ids[]`	Array	No	The scorecard ids.
`send_to`	Null	No	The email to send the results to.
`scorecard_grader_id`	Integer	No	The scorecard grader's id.
`days_ago_start`	Integer	No	Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_end to specify a range. Default value: 1
`scorecards_type`	Null	Yes	The type of scorecards statistics to be returned. Valid values: `"scorecard_export_leaderboard"` `"scorecard_export_calls"` `"scorecard_export_teamgroup_leaderboard"` `"scorecard_export_agent_leaderboard"` `"scorecard_export_calls_questions"`
`days_ago_end`	Integer	No	End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_start to specify a range. Default value: 30
`graded_days_ago_start`	Integer	No	Start of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded_days_ago_end to specify a range.
`target_id`	Integer	No	The target's id.
`target_type`	Null	No	The target's type. Valid values: `"coachingteam"` `"callcenter"` `"office"` `"unknown"` `"user"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.