{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pinterest Campaigns API",
    "version": "5.13.0"
  },
  "items": [
    {
      "info": {
        "name": "Campaigns",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/campaigns",
            "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": "entity_statuses",
                "value": "",
                "type": "query",
                "description": "Entity status"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order in which to sort the items returned: ASCENDING or DESCENDING\nby ID. Note that higher-value IDs are associated with more-recently added\nitems."
              },
              {
                "name": "bookmark",
                "value": "",
                "type": "query",
                "description": "Cursor used to fetch the next page of items"
              }
            ],
            "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 a list of the 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."
        },
        {
          "info": {
            "name": "Create campaigns",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/campaigns",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "Create multiple new campaigns. Every campaign has its own campaign_id and houses one or more ad groups, which contain one or more ads.\nFor more, see <a href=\"https://help.pinterest.com/en/business/article/set-up-your-campaign/\">Set up your campaign</a>. <p/>\n<strong>Note:</strong>\n- The values for 'lifetime_spend_cap' and 'daily_spend_cap' are microcurrency amounts based on the currency field set in the advertiser's profile. (e.g. USD) <p/>\n<p>Microcurrency is used to track very small transactio"
        },
        {
          "info": {
            "name": "Update campaigns",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/campaigns",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "Update multiple ad campaigns based on campaign_ids. <p/>\n<strong>Note:</strong><p/>\n - <p>The values for 'lifetime_spend_cap' and 'daily_spend_cap' are microcurrency amounts based on the currency field set in the advertiser's profile. (e.g. USD) <p/>\n<p>Microcurrency is used to track very small transactions, based on the currency set in the advertisers profile.</p>\n<p>A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser s profile.</p>\n<p><strong>Equivalency"
        },
        {
          "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 campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/campaigns/:campaign_id",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "Campaign ID, must be associated with the ad account ID provided in the path."
              }
            ],
            "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 a specific campaign given the campaign ID."
        }
      ]
    }
  ],
  "bundled": true
}