{ "opencollection": "1.0.0", "info": { "name": "Pinterest Groups API", "version": "5.13.0" }, "items": [ { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "List ad groups", "type": "http" }, "http": { "method": "GET", "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." }, { "name": "campaign_ids", "value": "", "type": "query", "description": "List of Campaign Ids to use to filter the results." }, { "name": "ad_group_ids", "value": "", "type": "query", "description": "List of Ad group 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" }, { "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 "
},
{
"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": "Create multiple product group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/catalogs/product_groups/multiple",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "query",
"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 product group to use in Catalogs owned by 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 (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Pagination for more information."
},
{
"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 a list of product groups for a given Catalogs Feed Id owned by 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 (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Pagination for more information."
},
{
"name": "product_group_id",
"value": "",
"type": "path",
"description": "Unique identifier of a product group"
},
{
"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 a list of product pins for a given Catalogs Product Group Id owned by 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 (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Pagination for more information."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"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 products Pins owned by the \"operation user_account\" that meet the criteria specified in the Catalogs Product Group Filter given in the request.\n- This endpoint has been implemented in POST to allow for complex filters. This specific POST endpoint is designed to be idempotent.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts<"
}
]
}
],
"bundled": true
}