NEnextdoor
Reporting

Creates a report based on the input passed in

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

Request

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

Path parameters

advertiserIdstring required

The id of the advertiser for which the request is made

Request body

dimensionsstring[]

The dimensions configured for the report

metricsstring[]

The metrics configured for the report

namestring

The report's name

output_format'CSV' | 'XLSX' nullable

Output format for the generated report. 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

advertiser_idstring

The id of the advertiser profile.

dimensionsstring[] nullable

The dimensions configured for the report.

download_urlstring

The download URL of the report.

idstring

The id of the report

metricsstring[] nullable

The report metrics.

namestring

The name of the report.

output_format'CSV' | 'XLSX'

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

status'STARTED' | 'IN_PROGRESS' | 'CANCELING' | 'CANCELED' | 'COMPLETED' | 'FAILED' | 'ARCHIVED' | 'UNKNOWN'

The status of the report.

Changes

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