{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pinterest Reports API",
    "version": "5.13.0"
  },
  "items": [
    {
      "info": {
        "name": "Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get advertiser Marketing Mix Modeling (MMM) report.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/mmm_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": "Get an mmm report for an ad account. This returns a URL to an mmm metrics report given a token returned from the\ncreate mmm report endpoint."
        },
        {
          "info": {
            "name": "Create a request for a Marketing Mix Modeling (MMM) report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/mmm_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 creates an asynchronous mmm report based on the given request. It returns a token that you can use to download\nthe report when it is ready. NOTE: An additional limit of 5 queries per minute per advertiser applies to this endpoint while it's in beta release."
        },
        {
          "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 <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: 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 <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Ana"
        },
        {
          "info": {
            "name": "Create async request for an analytics report using a template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/templates/:template_id/reports",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "template_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a template."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 2.5 years back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 2.5 years past start date."
              },
              {
                "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"
              }
            ],
            "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 catalogs report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/catalogs/reports",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "Token returned from async build report 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 a report given a token returned from <a href='/docs/api/v5/#operation/reports/create'>Build catalogs report</a>. You can use the URL to download the report.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the toke"
        },
        {
          "info": {
            "name": "Build catalogs report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pinterest.com/v5/catalogs/reports",
            "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": "Async request to create a report of the catalog owned by the \"operation user_account\". This endpoint generates a report upon receiving the first approved request of the day. Any following requests with identical parameters will yield the same report even if data has changed.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) t"
        },
        {
          "info": {
            "name": "List report stats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/catalogs/reports/stats",
            "params": [
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "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 <a href='/docs/getting-started/pagination/'>Pagination</a> for more information."
              },
              {
                "name": "bookmark",
                "value": "",
                "type": "query",
                "description": "Cursor used to fetch the next page of items"
              },
              {
                "name": "parameters",
                "value": "",
                "type": "query",
                "description": "Contains the parameters for report identification."
              }
            ],
            "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 aggregated numbers of issues for a catalog owned by the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following <a href=\"https://help.pinterest.com/en/busines"
        }
      ]
    }
  ],
  "bundled": true
}