{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pinterest Pin API",
    "version": "5.13.0"
  },
  "items": [
    {
      "info": {
        "name": "Pin",
        "type": "folder"
      },
      "items": [
        {
          "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 <code>pin_order_id</code>.\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, Finance, Campaign."
        },
        {
          "info": {
            "name": "Get Pin",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/pins/:pin_id",
            "params": [
              {
                "name": "pin_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Pin."
              },
              {
                "name": "pin_metrics",
                "value": "",
                "type": "query",
                "description": "Specify whether to return 90d and lifetime Pin metrics. Total comments and total reactions are only available with lifetime Pin metrics. If Pin was created before <code>2023-03-20</code> lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then."
              },
              {
                "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 Pin owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/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.p"
        },
        {
          "info": {
            "name": "Update Pin",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pinterest.com/v5/pins/:pin_id",
            "params": [
              {
                "name": "pin_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Pin."
              },
              {
                "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": "Update a pin owned by the \"operating 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/business/article/share-and-manage-access-t"
        },
        {
          "info": {
            "name": "Delete Pin",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pinterest.com/v5/pins/:pin_id",
            "params": [
              {
                "name": "pin_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Pin."
              },
              {
                "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": "Delete a Pins owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/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://he"
        },
        {
          "info": {
            "name": "Get Pin analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pinterest.com/v5/pins/:pin_id/analytics",
            "params": [
              {
                "name": "pin_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Pin."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date."
              },
              {
                "name": "app_types",
                "value": "",
                "type": "query",
                "description": "Apps or devices to get data for, default is all."
              },
              {
                "name": "metric_types",
                "value": "",
                "type": "query",
                "description": "Pin metric types to get data for. Keep in mind this cannot have ALL if split_field is set to any value other than <code>NO_SPLIT</code>."
              },
              {
                "name": "split_field",
                "value": "",
                "type": "query",
                "description": "How to split the data into groups. Not including this param means data won't be split."
              },
              {
                "name": "ad_account_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an ad account."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.pinterest.com/oauth/",
              "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get analytics for a Pin owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href=\"https://developers.pinterest.com/docs/api/v5/#operation/ad_accounts/list\">List ad accounts</a>) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must hav"
        },
        {
          "info": {
            "name": "Save Pin",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pinterest.com/v5/pins/:pin_id/save",
            "params": [
              {
                "name": "pin_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Pin."
              },
              {
                "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": "Save a Pin on a board or board section owned by the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account.\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/business/article/"
        }
      ]
    }
  ],
  "bundled": true
}