POST /api/v2/stats
Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /stats/{request_id}.
Stats for the whole company will be processed by default. An office_id can be provided to limit stats to a single office. A target_id and target_type can be provided to limit stats to a single target.
Added on May 3, 2018 for API v2.
Rate limit: 200 per hour.
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 |
|---|---|---|---|
coaching_group |
Boolean | No |
Whether or not the the statistics should be for trainees of the coach group with the given target_id. |
timezone |
String | No |
Timezone using a tz database name. Default value: "UTC" |
group_by |
String | No |
This param is only applicable when the stat_type is specified as call. For call stats, group calls by user per day (default), get total metrics by day, or break down by department and call center (office only). Possible values:
|
coaching_team |
Boolean | No |
Whether or not the the statistics should be for trainees of the coach team with the given target_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 |
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 |
is_today |
Boolean | No |
Whether or not the statistics are for the current day. NOTE: days_ago_start and days_ago_end are ignored if this is passed in. |
stat_type |
String | Yes |
The type of statistics to be returned. NOTE: if the value is "csat" or "dispositions", target_id and target_type must be specified. Possible values:
|
office_id |
Integer | No |
ID of the office to get statistics for. If a target_id and target_type are passed in this value is ignored and instead the target is used. |
target_id |
Integer | No |
The target's id. |
target_type |
String | No |
Target's type. Possible values:
|
export_type |
String | Yes |
Whether to return aggregated statistics (stats), or individual rows for each record (records). NOTE: For stat_type "csat" or "dispositions", only "records" is supported. Possible values:
|
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.