PIpinterest
resources

Get available metrics' definitions

Changed on

Get the definitions for ads and organic metrics available across both synchronous and asynchronous report endpoints. The display_name attribute will match how the metric is named in our native tools like Ads Manager. See Organic Analytics and Ads Analytics for more information.

get/resources/delivery_metrics

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    • OAuth 2
      Authorization codehttps://www.pinterest.com/oauth/
      Token URLhttps://api.pinterest.com/v5/oauth/token
      Scopesads:read, pins:read, user_accounts:read
    • or OAuth 2
      Client credentials
      Token URLhttps://api.pinterest.com/v3/oauth/access_token/
      Scopesads:read, pins:read, user_accounts:read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

report_type'SYNC' | 'ASYNC'

Report type.

Response

The request has succeeded.

Changes

  • v5b698c180678aRevision changes
    • breaking

      the // response's property type changed from no type to string for status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

  • v510f9eba4ad97Revision changes
    • info

      the endpoint scheme security client_credentials was added to the API