Reporting

Creates a report schedule based on the input passed in

post/api/v3/advertisers/{advertiserId}/reports/schedules

Request

Base URL
https://ads.nextdoor.com
URL
https://ads.nextdoor.com/api/v3/advertisers/{advertiserId}/reports/schedules
Auth
HTTP bearer

Path parameters

advertiserIdstring required

The id of the advertiser for which the request is made

Request body

dimensionsstring[]

The dimensions configured

metricsstring[]

The metrics configured

namestring

The report name

output_format'CSV' | 'XLSX' nullable

Output format for the generated reports. Defaults to CSV when omitted.

recipient_emailsstring[] nullable

The emails to send the report to

type'LEAD_GEN_FORM_RESULTS_REPORT' | 'DELIVERY_METRICS_REPORT' | 'DCO_ENTITY_REPORT'

The report type

Response

The newly created report schedule

advertiser_idstring

The advertiser id who owns the report schedule.

created_atstring date-time

The creation time of the report Schedule.

dimensionsstring[]

The dimensions configured for the report.

idstring

The id of the report schedule.

metricsstring[]

The report metrics.

namestring

The name of the report schedule.

output_format'CSV' | 'XLSX'

Output format of generated reports (e.g. CSV or XLSX).

recipient_emailsstring[]

A list of emails to send the report schedule to.

status'ARCHIVED' | 'ACTIVE' | 'PAUSED'

The status of the report schedule.

timezonestring

The timezone of the report schedule as a region, e.g. America/Los_Angeles.