API Reference

Scorecards export -- Initiate Processing

post
https://dialpad.com/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.

Body Params
int64 | null
Defaults to 30

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.

int64 | null
Defaults to 1

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.

int64 | null

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.

int64 | null

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.

int64 | null

The scorecard grader's id.

scorecard_ids
array of int64s | null

The scorecard ids.

scorecard_ids
string | null
enum
required

The type of scorecards statistics to be returned.

Allowed:
string | null

The email to send the results to.

int64 | null

The target's id.

string | null
enum

The target's type.

Allowed:
string | null
Defaults to UTC

Timezone using a tz database name.

Response

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago