---
title: "Build catalogs report"
method: POST
path: "/catalogs/reports"
tags: ["catalog_reports"]
---

# Build catalogs report

`POST /catalogs/reports`

Async request to create a report of the catalog owned by the "operation user_account". This endpoint generates a report upon receiving the first approved request of the day. Any following requests with identical parameters will yield the same report even if data has changed.
- By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.

Note: The All Items report is limited to 25 million items per catalog.

## Query parameters

- `ad_account_id` string

## Request body

- union — Report parameters
  - object — Parameters for retail report
    - `catalog_type` 'RETAIL', required
    - `report` union, required
      - object
        - `feed_id` string, required — ID of the feed entity.
        - `processing_result_id` string — Unique identifier of a feed processing result. It can be acquired from the "id" field of the "items" array within the response of the [List processing results for a given feed](/docs/api/v5/#operation/feed_processing_results/list). If not provided, default to most recent completed processing result.
        - `report_type` 'FEED_INGESTION_ISSUES', required
      - object
        - `catalog_id` string — Unique identifier of a catalog. If not given, oldest catalog will be used
        - `report_type` 'DISTRIBUTION_ISSUES', required
      - object — ALL_ITEMS filter for retail catalogs. Optional product_group_id scopes the report to items in that product group. If omitted, all items are included.
        - `catalog_id` string — Unique identifier of a catalog. If not given, oldest catalog will be used
        - `product_group_id` string — Optional product group ID. If omitted, all items are included. This feature is only available for allowlisted merchants. Please contact your account manager to enable this feature.
        - `report_type` 'ALL_ITEMS', required
  - object — Parameters for hotel report
    - `catalog_type` 'HOTEL', required
    - `report` union, required
      - object
        - `feed_id` string, required — ID of the feed entity.
        - `processing_result_id` string — Unique identifier of a feed processing result. It can be acquired from the "id" field of the "items" array within the response of the [List processing results for a given feed](/docs/api/v5/#operation/feed_processing_results/list). If not provided, default to most recent completed processing result.
        - `report_type` 'FEED_INGESTION_ISSUES', required
      - object
        - `catalog_id` string — Unique identifier of a catalog. If not given, oldest catalog will be used
        - `report_type` 'DISTRIBUTION_ISSUES', required

## Response `200`

The request has succeeded.

- CatalogsCreateReportResponse
  - `token` string — Token to be used to get the report

## Other responses

- `201` — Resource create operation completed successfully.
- `400` — The request could not be understood by the server due to unexpected data.
- `401` — Authentication is required and has either failed or not been provided.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404` — The requested resource could not be found on this server.
- `429` — The user has sent too many requests in a given amount of time and is being rate limited.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.net/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/b698c180678a/schema)