Reporting

Returns the report information

get/api/v3/advertisers/{advertiserId}/reports/{reportId}

Request

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

Path parameters

advertiserIdstring required

The advertiser id for which to fetch the ad info

reportIdstring required

The report id for which to fetch the info

Response

The report with the id specified in the URL

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.