{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pinterest Metrics API",
    "version": "5.13.0"
  },
  "items": [
    {
      "info": {
        "name": "Metrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get country's keyword metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/keywords/metrics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "country_code",
                "value": "US",
                "type": "query",
                "description": "Two letter country code (ISO 3166-1 alpha-2)"
              },
              {
                "name": "keywords",
                "value": "",
                "type": "query",
                "description": "Comma-separated keywords"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.pinterest.com/oauth/",
              "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "See keyword metrics for a specified country, aggregated across all of Pinterest.\n(Definitions are available from the \"Get delivery metrics definitions\"\n<a href=\"/docs/api/v5/#operation/delivery_metrics/get\">API endpoint</a>)."
        },
        {
          "info": {
            "name": "Get available metrics' definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/resources/delivery_metrics",
            "params": [
              {
                "name": "report_type",
                "value": "",
                "type": "query",
                "description": "Report type."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.pinterest.com/oauth/",
              "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get the definitions for ads and organic metrics available across both synchronous and asynchronous report endpoints.\nThe `display_name` attribute will match how the metric is named in our native tools like Ads Manager.\nSee <a href='/docs/content/analytics/'>Organic Analytics</a> and <a href='/docs/ads/ad-analytics-reporting/'>Ads Analytics</a> for more information."
        },
        {
          "info": {
            "name": "Get metrics ready state",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/resources/metrics_ready_state",
            "params": [
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Analytics reports request date (UTC). Format: YYYY-MM-DD"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.pinterest.com/oauth/",
              "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Learn whether conversion or non-conversion metrics are finalized and ready to query."
        }
      ]
    }
  ],
  "bundled": true
}