API Reference
Start typing to search…

schedule reports -- Create

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

Body Params
int64 | null
required

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.

boolean | null
Defaults to false

Whether the the statistics should be for trainees of the coach group with the given target_id.

boolean | null
Defaults to true

Whether or not this schedule reports event subscription is enabled.

int64 | null
required

The logging endpoint's ID, which is generated after creating a webhook or websocket successfully.

string | null
enum
required

How often the report will execute.

Allowed:
string | null
required

[single-line only]

The name of the schedule reports.

int64 | null
required

The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30.

string | null
enum
required

The type of report that will be generated.

Allowed:
int64 | null

The target's id.

string | null
enum

Target's type.

string | null

Timezone using a tz database name.

Response

Updated 4 months ago

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