{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pinterest Analytics API",
    "version": "5.13.0"
  },
  "items": [
    {
      "info": {
        "name": "Analytics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get ad group analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ad_groups/analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "ad_group_ids",
                "value": "",
                "type": "query",
                "description": "List of Ad group Ids to use to filter the results."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              }
            ],
            "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 analytics for the specified ad groups in the specified <code>ad_account_id</code>, filtered by the specified options.\n- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.\n- If granularity is not HOUR, the furthest back you can are allowed to pull data is 90"
        },
        {
          "info": {
            "name": "Get targeting analytics for ad groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ad_groups/targeting_analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "ad_group_ids",
                "value": "",
                "type": "query",
                "description": "List of Ad group Ids to use to filter the results."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "targeting_types",
                "value": "",
                "type": "query",
                "description": "Targeting type breakdowns for the report. The reporting per targeting type <br> is independent from each other. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              },
              {
                "name": "attribution_types",
                "value": "",
                "type": "query",
                "description": "List of types of attribution for the conversion report"
              }
            ],
            "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 targeting analytics for one or more ad groups.\nFor the requested ad group(s) and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/>\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\n<a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-acco"
        },
        {
          "info": {
            "name": "Get ad analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ads/analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "ad_ids",
                "value": "",
                "type": "query",
                "description": "List of Ad Ids to use to filter the results."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              }
            ],
            "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 analytics for the specified ads in the specified <code>ad_account_id</code>, filtered by the specified options.\n- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.\n- If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days "
        },
        {
          "info": {
            "name": "Get targeting analytics for ads",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ads/targeting_analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "ad_ids",
                "value": "",
                "type": "query",
                "description": "List of Ad Ids to use to filter the results."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "targeting_types",
                "value": "",
                "type": "query",
                "description": "Targeting type breakdowns for the report. The reporting per targeting type <br> is independent from each other. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              },
              {
                "name": "attribution_types",
                "value": "",
                "type": "query",
                "description": "List of types of attribution for the conversion report"
              }
            ],
            "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 targeting analytics for one or more ads. For the requested ad(s) and metrics,\nthe response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type\n(e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/>\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\n<a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Busine"
        },
        {
          "info": {
            "name": "Get ad account analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              }
            ],
            "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 analytics for the specified <code>ad_account_id</code>, filtered by the specified options.\n- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.\n- If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current da"
        },
        {
          "info": {
            "name": "Get campaign analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/campaigns/analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "campaign_ids",
                "value": "",
                "type": "query",
                "description": "List of Campaign Ids to use to filter the results."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              }
            ],
            "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 analytics for the specified campaigns in the specified <code>ad_account_id</code>, filtered by the specified options.\n- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.\n- If granularity is not HOUR, the furthest back you can are allowed to pull data is 90"
        },
        {
          "info": {
            "name": "Get targeting analytics for campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/campaigns/targeting_analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "campaign_ids",
                "value": "",
                "type": "query",
                "description": "List of Campaign Ids to use to filter the results."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "targeting_types",
                "value": "",
                "type": "query",
                "description": "Targeting type breakdowns for the report. The reporting per targeting type <br> is independent from each other. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              },
              {
                "name": "attribution_types",
                "value": "",
                "type": "query",
                "description": "List of types of attribution for the conversion report"
              }
            ],
            "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 targeting analytics for one or more campaigns.\nFor the requested account and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/>\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\n<a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts"
        },
        {
          "info": {
            "name": "Get product group analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/product_groups/analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "product_group_ids",
                "value": "",
                "type": "query",
                "description": "List of Product group Ids to use to filter the results."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              }
            ],
            "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 analytics for the specified product groups in the specified <code>ad_account_id</code>, filtered by the specified options.\n- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.\n- If granularity is not HOUR, the furthest back you can are allowed to pull data "
        },
        {
          "info": {
            "name": "Get targeting analytics for an ad account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/targeting_analytics",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "targeting_types",
                "value": "",
                "type": "query",
                "description": "Targeting type breakdowns for the report. The reporting per targeting type <br> is independent from each other. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users."
              },
              {
                "name": "columns",
                "value": "",
                "type": "query",
                "description": "Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned"
              },
              {
                "name": "granularity",
                "value": "DAY",
                "type": "query",
                "description": "TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly"
              },
              {
                "name": "click_window_days",
                "value": "1",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "engagement_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days."
              },
              {
                "name": "view_window_days",
                "value": "",
                "type": "query",
                "description": "Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day."
              },
              {
                "name": "conversion_report_time",
                "value": "TIME_OF_AD_ACTION",
                "type": "query",
                "description": "The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event."
              },
              {
                "name": "attribution_types",
                "value": "",
                "type": "query",
                "description": "List of types of attribution for the conversion report"
              }
            ],
            "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 targeting analytics for an ad account.\nFor the requested account and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/>\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\n<a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Busine"
        },
        {
          "info": {
            "name": "Get Pin analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/pins/:pin_id/analytics",
            "params": [
              {
                "name": "pin_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Pin."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "app_types",
                "value": "",
                "type": "query",
                "description": "Apps or devices to get data for, default is all."
              },
              {
                "name": "metric_types",
                "value": "",
                "type": "query",
                "description": "Pin metric types to get data for. Keep in mind this cannot have ALL if split_field is set to any value other than <code>NO_SPLIT</code>."
              },
              {
                "name": "split_field",
                "value": "",
                "type": "query",
                "description": "How to split the data into groups. Not including this param means data won't be split."
              },
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              }
            ],
            "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 analytics for a Pin owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href=\"https://developers.pinterest.com/docs/api/v5/#operation/ad_accounts/list\">List ad accounts</a>) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must hav"
        },
        {
          "info": {
            "name": "Get multiple Pin analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/pins/analytics",
            "params": [
              {
                "name": "pin_ids",
                "value": "",
                "type": "query",
                "description": "List of Pin IDs."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "app_types",
                "value": "",
                "type": "query",
                "description": "Apps or devices to get data for, default is all."
              },
              {
                "name": "metric_types",
                "value": "",
                "type": "query",
                "description": "Pin metric types to get data for."
              },
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              }
            ],
            "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": "<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/new/about-beta-access/'>Learn more</a>.</strong>\n\nGet analytics for multiple pins owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- The maximum number of pins supported in a single request is 100.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href=\"htt"
        },
        {
          "info": {
            "name": "Get user account analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/user_account/analytics",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "from_claimed_content",
                "value": "",
                "type": "query",
                "description": "Filter on Pins that match your claimed domain."
              },
              {
                "name": "pin_format",
                "value": "",
                "type": "query",
                "description": "Pin formats to get data for, default is all."
              },
              {
                "name": "app_types",
                "value": "",
                "type": "query",
                "description": "Apps or devices to get data for, default is all."
              },
              {
                "name": "content_type",
                "value": "",
                "type": "query",
                "description": "Filter to paid or organic data. Default is all."
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts"
              },
              {
                "name": "metric_types",
                "value": "",
                "type": "query",
                "description": "Metric types to get data for, default is all. "
              },
              {
                "name": "split_field",
                "value": "",
                "type": "query",
                "description": "How to split the data into groups. Not including this param means data won't be split."
              },
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              }
            ],
            "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 analytics for the \"operation user_account\"\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\"."
        },
        {
          "info": {
            "name": "Get user account top pins analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/user_account/analytics/top_pins",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Specify sorting order for metrics"
              },
              {
                "name": "from_claimed_content",
                "value": "",
                "type": "query",
                "description": "Filter on Pins that match your claimed domain."
              },
              {
                "name": "pin_format",
                "value": "",
                "type": "query",
                "description": "Pin formats to get data for, default is all."
              },
              {
                "name": "app_types",
                "value": "",
                "type": "query",
                "description": "Apps or devices to get data for, default is all."
              },
              {
                "name": "content_type",
                "value": "",
                "type": "query",
                "description": "Filter to paid or organic data. Default is all."
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts"
              },
              {
                "name": "metric_types",
                "value": "",
                "type": "query",
                "description": "Metric types to get data for, default is all. "
              },
              {
                "name": "num_of_pins",
                "value": "25",
                "type": "query",
                "description": "Number of pins to include, default is 10. Max is 50."
              },
              {
                "name": "created_in_last_n_days",
                "value": "30",
                "type": "query",
                "description": "Get metrics for pins created in the last \"n\" days."
              },
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              }
            ],
            "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": "Gets analytics data about a user's top pins (limited to the top 50).\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\"."
        },
        {
          "info": {
            "name": "Get user account top video pins analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/user_account/analytics/top_video_pins",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Specify sorting order for video metrics"
              },
              {
                "name": "from_claimed_content",
                "value": "",
                "type": "query",
                "description": "Filter on Pins that match your claimed domain."
              },
              {
                "name": "pin_format",
                "value": "",
                "type": "query",
                "description": "Pin formats to get data for, default is all."
              },
              {
                "name": "app_types",
                "value": "",
                "type": "query",
                "description": "Apps or devices to get data for, default is all."
              },
              {
                "name": "content_type",
                "value": "",
                "type": "query",
                "description": "Filter to paid or organic data. Default is all."
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts"
              },
              {
                "name": "metric_types",
                "value": "",
                "type": "query",
                "description": "Metric types to get video data for, default is all. "
              },
              {
                "name": "num_of_pins",
                "value": "25",
                "type": "query",
                "description": "Number of pins to include, default is 10. Max is 50."
              },
              {
                "name": "created_in_last_n_days",
                "value": "30",
                "type": "query",
                "description": "Get metrics for pins created in the last \"n\" days."
              },
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              }
            ],
            "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": "Gets analytics data about a user's top video pins (limited to the top 50).\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\"."
        }
      ]
    }
  ],
  "bundled": true
}