NEnextdoor
Reporting

Returns a report schedule information

get/api/v3/advertisers/{advertiserId}/reports/schedules/{scheduleId}

Request

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

Path parameters

advertiserIdstring required

The advertiser id for which to fetch the report schedule info

scheduleIdstring required

The report Schedule for which to fetch the info

Response

The report schedule with the id specified in the URL

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.

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

The specific type report schedule.

updated_atstring date-time

The last update time of the report Schedule.

Changes

No recorded changes to this operation across all 1 revision of this API.