{ "opencollection": "1.0.0", "info": { "name": "Pinterest Ad API", "version": "5.13.0" }, "items": [ { "info": { "name": "Ad", "type": "folder" }, "items": [ { "info": { "name": "List ad accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/ad_accounts", "params": [ { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." }, { "name": "include_shared_accounts", "value": "", "type": "query", "description": "Include shared ad accounts" } ], "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 ad_accounts that the \"operation user_account\" has access to.\n- This includes ad_accounts they own and ad_accounts that are owned by others who have granted them Business Access." }, { "info": { "name": "Create ad account", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/ad_accounts", "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 a new ad account. Different ad accounts can support different currencies, payment methods, etc.\nAn ad account is needed to create campaigns, ad groups, and ads; other accounts (your employees or partners) can be assigned business access and appropriate roles to access an ad account.
\nYou can set up up to 50 ad accounts per user. (The user must have a business account to create an ad account.) \nFor more, see Pagination 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" }, { "name": "translate_interests_to_names", "value": "", "type": "query", "description": "Return interests as text names (if value is true) rather than topic IDs." } ], "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": "List ad groups based on provided campaign IDs or ad group IDs.(campaign_ids or ad_group_ids). \nNote:\nProvide only campaign_id or ad_group_id. Do not provide both." }, { "info": { "name": "Create ad groups", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ad_groups", "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 ad groups. All ads in a given ad group will have the same budget, bid, run dates, targeting, and placement (search, browse, other). For more information, click here.\nNote:\n- 'bid_in_micro_currency' and 'budget_in_micro_currency' should be expressed in microcurrency amounts based on the currency field set in the advertiser's profile.\nMicrocurrency is use"
},
{
"info": {
"name": "Update ad groups",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ad_groups",
"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 existing ad groups."
},
{
"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.
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).
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.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
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 ad_account_id, 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 Business Access: 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
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.
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).
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.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
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\").
ad_account_id, 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 Business Access: 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 ads credit discounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ads_credit/discounts",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
}
],
"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": "Returns the list of discounts applied to the account.\n\nThis endpoint might not be available to all apps. Learn more."
},
{
"info": {
"name": "Redeem ad credits",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ads_credit/redeem",
"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": "Redeem ads credit on behalf of the ad account id and apply it towards billing.\n\nThis endpoint might not be available to all apps. Learn more."
},
{
"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 ad_account_id, 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 Business Access: 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 audience insights",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/audience_insights",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "audience_insight_type",
"value": "",
"type": "query",
"description": "Type of audience insights."
}
],
"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 Audience Insights for an ad account. The response will return insights for 3 types of audiences: the\nad account's engaged audience on Pinterest, the ad account's total audience on Pinterest and Pinterest's\ntotal audience.\nLearn more about Audience Insights."
},
{
"info": {
"name": "List audiences",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/audiences",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The order in which to sort the items returned: ASCENDING or DESCENDING by ID.\nFor received audiences, it is sorted by sharing event time.\nNote that higher-value IDs are associated with more-recently added items."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
},
{
"name": "ownership_type",
"value": "OWNED",
"type": "query",
"description": "This feature is currently in beta and not available to all apps.\nFilter audiences by ownership 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 list of audiences for the ad account."
},
{
"info": {
"name": "Create audience",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/audiences",
"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 an audience you can use in targeting for specific ad groups. Targeting combines customer information with\nthe ways users interact with Pinterest to help you reach specific groups of users; you can include or exclude\nspecific audience_ids when you create an ad group. \nFor more, see Audience targeting."
},
{
"info": {
"name": "Get audience",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/audiences/:audience_id",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "audience_id",
"value": "",
"type": "path",
"description": "Unique identifier of an audience"
}
],
"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 audience given the audience ID."
},
{
"info": {
"name": "Update audience",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/audiences/:audience_id",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "audience_id",
"value": "",
"type": "path",
"description": "Unique identifier of an audience"
}
],
"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 (edit or remove) an existing targeting audience."
},
{
"info": {
"name": "Create custom audience",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/audiences/custom",
"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 a custom audience and find the audiences you want your ads to reach."
},
{
"info": {
"name": "Get bid floors",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/bid_floor",
"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": "List bid floors for your campaign configuration. Bid floors are given in microcurrency values based on the currency in the bid floor specification. \nMicrocurrency is used to track very small transactions, based on the currency set in the advertisers profile.
\nA microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser s profile.
\nEquivalency equations, using dollars as an example currency:
\nrequest_id\nthat can be used to obtain the status of the request."
},
{
"info": {
"name": "Download advertiser entities in bulk",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/bulk/:bulk_request_id",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "bulk_request_id",
"value": "",
"type": "path",
"description": "Unique identifier of a bulk upsert request."
},
{
"name": "include_details",
"value": "",
"type": "query",
"description": "if set to True then attach the errors/details to all the requests"
}
],
"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 status of a bulk request by request_id, along with a download URL that will allow you to download the\nnew or updated entity data (campaigns, ad groups, product groups, ads, or keywords)."
},
{
"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 Pagination 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 ad_account_id, 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 Business Access: 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 Set up your campaign. \nNote:\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) \nMicrocurrency 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.
\nNote:\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)
\nMicrocurrency is used to track very small transactions, based on the currency set in the advertisers profile.
\nA microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser s profile.
\nEquivalency"
},
{
"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. Get a set of customer lists including id and name based on the filters provided. (Customer lists are a type of audience.) For more information, see\nAudience targeting\n or the Audiences\nsection of the ads management guide. Create a customer list from your records(hashed or plain-text email addresses, or hashed MAIDs or IDFAs). A customer list is one of the four types of Pinterest audiences: for more information, see Audience targeting\nor the Audiences section of the ads management guide. Please review our Append or remove records to/from an existing customer list. (A customer list is one of the four types of Pinterest audiences.) When you add records to an existing customer list, the system scans the additions for existing Pinterest\naccounts; those are the records that will be added to your CUSTOMER_LIST audience. Your original list of records\n to add will be deleted when the matching process is complete. For more information, see ad_account_id. The request body should be a JSON object.\n- This endpoint requires an Get a list of keywords based on the filters provided. If no filter is provided, it will default to the ad_account_id filter, which means it will only return keywords that specifically have parent_id set to the ad_account_id. Note: Keywords can have ad_account_ids, campaign_ids, and ad_group_ids set as their parent_ids. Keywords created through Ads Manager will have their parent_id set to an ad_group_id, not ad_account_id. For more information, see Create keywords for following entity types(advertiser, campaign, ad group or ad). For more information, see Keyword targeting. Notes: For more information on match types, se"
},
{
"info": {
"name": "Update keywords",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/keywords",
"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 one or more keywords' bid and archived fields. Archiving a keyword effectively deletes it - keywords no longer receive metrics and no longer visible within the parent entity's keywords list. Targeting templates allow advertisers to save a set of targeting details including audience lists,\n keywords & interest, demographics, and placements to use more than once during the campaign creation process. Templates can be used to build out basic targeting criteria that you plan to use across campaigns and to reuse\n performance targeting from prior campaigns for new campaigns. Update the targeting template given advertiser ID and targeting template ID
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).
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.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
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 ad_account_id, 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 Business Access: 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
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.
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).
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.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
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\"). \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\nPinterest tag, with the option to enable enhanced match.\nThe Pinterest Tag tracks actions people take on the ad account s website after they view the ad account's ad on Pinterest. The advertiser needs to customize this tag to track conversions.\nFor more information, see:\nPagination 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 all page visit conversion tag events for an ad account."
},
{
"info": {
"name": "Get conversion tag",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/conversion_tags/:conversion_tag_id",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "conversion_tag_id",
"value": "2617998078212",
"type": "path",
"description": "Id of the conversion tag."
}
],
"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 information about an existing conversion tag."
},
{
"info": {
"name": "Get customer lists",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/customer_lists",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination 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": "access_token be generated through Ads Manager. Review the Conversions Guide for more details.\n- The token's user_account must either be the Owner of "
},
{
"info": {
"name": "Get audience insights scope and type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/insights/audiences",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"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 the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction (referred to here as a type) on pins. Interacted pins can belong to at least the most common **partner** or **Pinterest** scopes. This means that user interactions made on advertiser or partner pins will have the **partner** scope. You can also have user interactions performed in general on Pinterest with the **Pinterest** scope. In that case, you can then use the returned "
},
{
"info": {
"name": "Get keywords",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/keywords",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "campaign_id",
"value": "",
"type": "query",
"description": "Campaign Id to use to filter the results."
},
{
"name": "ad_group_id",
"value": "123123123",
"type": "query",
"description": "Ad group Id."
},
{
"name": "match_types",
"value": "",
"type": "query",
"description": "Keyword match type"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
},
{
"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": "
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).
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.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
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 ad_account_id, 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 Business Access: Admin, Analyst, Campaign Manager.\n- If granularity is not HOUR, the furthest back you can are allowed to pull data "
},
{
"info": {
"name": "Get catalog product groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/product_groups/catalogs",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "feed_profile_id",
"value": "",
"type": "query",
"description": "The feed profile id whose catalog product groups we want to return."
}
],
"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": "This endpoint is completely deprecated. Please use List product groups from Catalogs API instead."
},
{
"info": {
"name": "Get the account analytics report created by the async call",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/reports",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Token returned from the post request creation call"
}
],
"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": "This returns a URL to an analytics report given a token returned from the post request report creation call. You can use the URL to download the report. The link is valid for five minutes and the report is valid for one hour.\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 Business Access: Admin, Analyst, "
},
{
"info": {
"name": "Create async request for an account analytics report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/reports",
"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": "This returns a token that you can use to download the report when it is ready. Note that this endpoint requires the parameters to be passed as JSON-formatted in the request body. This endpoint does not support URL query parameters.\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 Business Access: Admin, Ana"
},
{
"info": {
"name": "Delete ads data for ad account in API Sandbox",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/sandbox",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"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": "Delete an ad account and all the ads data associated with that account. \nA string message is returned indicating the status of the delete operation.\n\nNote: This endpoint is only allowed in the Pinterest API Sandbox (https://api-sandbox.pinterest.com/v5). \nGo to https://developers.pinterest.com/docs/dev-tools/sandbox/ for more information."
},
{
"info": {
"name": "Get Salesforce account details including bill-to information.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ssio/accounts",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"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 Salesforce account details including bill-to information to be used in insertion orders process for ad_account_id.\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 Business Access: Admin, Finance, Campaign."
},
{
"info": {
"name": "Create insertion order through SSIO.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ssio/insertion_orders",
"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 insertion order through SSIO for ad_account_id.\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 Business Access: Admin, Finance, Campaign."
},
{
"info": {
"name": "Edit insertion order through SSIO.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ssio/insertion_orders",
"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": "Edit insertion order through SSIO for ad_account_id.\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 Business Access: Admin, Finance, Campaign."
},
{
"info": {
"name": "Get insertion order status by ad account id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ssio/insertion_orders/status",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
}
],
"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 insertion order status for account id ad_account_id.\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 Business Access: Admin, Finance, Campaign."
},
{
"info": {
"name": "Get insertion order status by pin order id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ssio/insertion_orders/:pin_order_id/status",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "pin_order_id",
"value": "",
"type": "path",
"description": "The pin order id associated with the ssio insertion order"
}
],
"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 insertion order status for pin order id pin_order_id.\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 Business Access: Admin, Finance, Campaign."
},
{
"info": {
"name": "Get Salesforce order lines by ad account id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/ssio/order_lines",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
},
{
"name": "pin_order_id",
"value": "",
"type": "query",
"description": "The pin order id associated with the ssio insertino order"
}
],
"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 Salesforce order lines for account id ad_account_id.\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 Business Access: Admin, Finance, Campaign."
},
{
"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
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.
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).
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.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
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\"). \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\nBusine"
},
{
"info": {
"name": "List targeting templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/targeting_templates",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"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": "include_sizing",
"value": "",
"type": "query",
"description": "Include audience sizing in result or not"
},
{
"name": "search_query",
"value": "gaming",
"type": "query",
"description": "Search keyword for targeting templates"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
},
{
"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 targeting templates in the specified ad_account_id"
},
{
"info": {
"name": "Create targeting templates",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/targeting_templates",
"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": "
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
MONTHLY - metrics are broken down monthly"
}
],
"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": "This takes a template ID and an optional custom timeframe and constructs an asynchronous report based on the\ntemplate. It returns a token that you can use to download the report when it is ready."
},
{
"info": {
"name": "Get terms of service",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/terms_of_service",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "include_html",
"value": "",
"type": "query",
"description": "Return HTML in TOS text."
},
{
"name": "tos_type",
"value": "",
"type": "query",
"description": "Request 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 text of the terms of service and see whether the advertiser has accepted the terms of service."
},
{
"info": {
"name": "Get ad accounts countries",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/resources/ad_account_countries",
"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 Ad Accounts countries"
}
]
}
],
"bundled": true
}