---
title: "Returns a list of report schedules for the advertiser."
method: GET
path: "/api/v3/advertisers/{advertiserId}/reports/schedules"
tags: ["Reporting"]
---

# Returns a list of report schedules for the advertiser.

`GET /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

- `advertiserId` string, required

## Query parameters

- `cursor` string
- `pageSize` integer, required

## Response `200`

A list of report schedules for the advertiser paginated

- object
  - `page_info` object: The pagination info for the api caller to get the rest of the advertiser's report schedules.
    - `end_cursor` string, nullable: The end cursor of the current page result, typically this is the cursor of the last object.
    - `page_size` integer: The number of results returned in this page.
  - `schedules` object[]: The list of report schedules returned in this paginated call.
    - `cursor` string: The cursor of the report schedule.
    - `data` object: The report Schedule data.
      - `advertiser_id` string: The advertiser id who owns the report schedule.
      - `created_at` string, date-time: The creation time of the report Schedule.
      - `dimensions` string[]: The dimensions configured for the report.
      - `filters` object[], nullable: List of filters for the reports, e.g. Campaign ID contains 1234, e.g. Campaign ID contains 1234.
        - `attribute` 'AD' | 'AD_GROUP' | 'CAMPAIGN' | 'PLACEMENT': Report attribute to filter by.
        - `operator` 'CONTAINS': Filter operator
        - `options` string[]: User selected values to filter on.
      - `id` string: The id of the report schedule.
      - `metrics` string[]: The report metrics.
      - `name` string: The name of the report schedule.
      - `output_format` 'CSV' | 'XLSX': Output format of generated reports (e.g. CSV or XLSX).
      - `recipient_emails` string[]: A list of emails to send the report schedule to.
      - `schedule` object: The schedule of the report.
        - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ON_FORM_SUBMISSION'
        - `lookback_days` integer
        - `weekly_day_of_week` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
        - `monthly_calendar` boolean
      - `status` 'ARCHIVED' | 'ACTIVE' | 'PAUSED': The status of the report schedule.
      - `timezone` string: 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_at` string, date-time: The last update time of the report Schedule.

## Other responses

- `400`: Bad Request. Indicates that the server cannot process the request due to client-side error. For example invalid input.
- `401`: Unauthorized. The API key is invalid and needs to be re-generated.
- `403`: Forbidden. The token passed in has been successfully authenticated, but can’t perform the given action due to not having sufficient permissions.
- `500`: Internal server error.
- `503`: The server is temporarily unable to handle the request due to maintenance or overload.

---

[API](https://skmtc.dev/nextdoor/apis/advertising.md) - [All operations](https://skmtc.dev/nextdoor/apis/advertising/llms.txt) - [OpenAPI document](https://skmtc.dev/nextdoor/apis/advertising/revisions/cdbbecabcffc?raw)