POST /api/v2/schedulereports
Creates a schedule reports subscription for your company. An endpoint_id is required in order to receive the event payload and can be obtained via websockets or webhooks. A schedule reports is a mechanism to schedule daily, weekly or monthly record and statistics reports.
Added on Jun 17, 2022 for API v2.
Rate limit: 1200 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 |
|---|---|---|---|
coaching_group |
Boolean | No |
Whether the the statistics should be for trainees of the coach group with the given target_id. Default value: false |
timezone |
String | No |
Timezone using a tz database name. |
frequency |
String | Yes |
How often the report will execute. Possible values:
|
name |
String | Yes |
[single-line only] The name of the schedule reports. |
report_type |
String | Yes |
The type of report that will be generated. Possible values:
|
on_day |
Integer | Yes |
The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30. |
endpoint_id |
Integer | Yes |
The logging endpoint's ID, which is generated after creating a webhook or websocket successfully. |
at |
Integer | Yes |
Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am. |
enabled |
Boolean | No |
Whether or not this schedule reports event subscription is enabled. Default value: true |
target_id |
Integer | No |
The target's id. |
target_type |
String | No |
Target's type. 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.