Sign in
catalog_reports

Build catalogs report

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) 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 roles on the ad_account: Owner, Admin, Catalogs Manager.

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

post/catalogs/reports

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

OR

Response

The request has succeeded.

tokenstring

Token to be used to get the report

Changes

Changed in 3 of the 29 revisions of this API.2318

  • v5b698c180678a239See the full diff
    • ▲

      removed CatalogsReportAllItemsFilter from the oneOf[CatalogsHotelReportParameters]/report request property oneOf list

      request-property-one-of-removed

    • ▲

      removed CatalogsReportAllItemsFilter from the oneOf[CatalogsRetailReportParameters]/report request property oneOf list

      request-property-one-of-removed

    • ●

      removed the request property catalog_type

      request-property-removed

    • ●

      removed the request property oneOf[CatalogsHotelReportParameters]/report/report_type

      request-property-removed

    • ●

      removed the request property oneOf[CatalogsRetailReportParameters]/report/report_type

      request-property-removed

    • ○

      mapped value for discriminator key ALL_ITEMS changed from CatalogsReportAllItemsFilter to CatalogsRetailReportAllItemsFilter for oneOf[CatalogsRetailReportParameters]/report request property

      request-property-discriminator-mapping-changed

    • ○

      removed ALL_ITEMS discriminator mapping keys from the oneOf[CatalogsHotelReportParameters]/report request property

      request-property-discriminator-mapping-deleted

    • ○

      added CatalogsRetailReportAllItemsFilter to the oneOf[CatalogsRetailReportParameters]/report request property oneOf list

      request-property-one-of-added

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      removed the non-success response with the status 409

      response-non-success-status-removed

    • ○

      added the success response with the status 201

      response-success-status-added

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v510f9eba4ad978See the full diff
    • ○

      api tag catalog_reports added

      api-tag-added

    • ○

      api tag catalogs removed

      api-tag-removed

    • ○

      added ALL_ITEMS discriminator mapping keys to the oneOf[CatalogsHotelReportParameters]/report request property

      request-property-discriminator-mapping-added

    • ○

      added ALL_ITEMS discriminator mapping keys to the oneOf[CatalogsRetailReportParameters]/report request property

      request-property-discriminator-mapping-added

    • ○

      added the new ALL_ITEMS enum value to the request property oneOf[CatalogsHotelReportParameters]/report/report_type

      request-property-enum-value-added

    • ○

      added the new ALL_ITEMS enum value to the request property oneOf[CatalogsRetailReportParameters]/report/report_type

      request-property-enum-value-added

    • ○

      added CatalogsReportAllItemsFilter to the oneOf[CatalogsHotelReportParameters]/report request property oneOf list

      request-property-one-of-added

    • ○

      added CatalogsReportAllItemsFilter to the oneOf[CatalogsRetailReportParameters]/report request property oneOf list

      request-property-one-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5f9321315766f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog