{
  "opencollection": "1.0.0",
  "info": {
    "name": "Braze Export > Purchases API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Export > Purchases",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Export Product IDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.iad-01.braze.com/purchases/product_list",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer {{api_key}}"
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "(Optional) Integer\n\nThe page of your product list that you would like to view."
              }
            ]
          },
          "docs": "> Use this endpoint to return a paginated lists of product IDs. \n  \n\nTo use this endpoint, youll need to generate an API key with the `purchases.product_list` permission.\n\n## Rate limit\n\nFor customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/events/list` endpoint, as documented in [API rate limits](https://www.braze.com/docs/api/api_limits/).\n\n## Response\n\n``` json\nConte"
        },
        {
          "info": {
            "name": "Export Number of Purchases",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.iad-01.braze.com/purchases/quantity_series",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer {{api_key}}"
              }
            ],
            "params": [
              {
                "name": "ending_at",
                "value": "2018-06-28T23:59:59-5:00",
                "type": "query",
                "description": "(Optional) Datetime (ISO 8601 string)\nDate on which the data series should end. Defaults to time of the request."
              },
              {
                "name": "length",
                "value": "100",
                "type": "query",
                "description": "(Required) Integer\nMaximum number of days before ending_at to include in the returned series. Must be between 1 and 100 (inclusive)."
              },
              {
                "name": "unit",
                "value": "14",
                "type": "query",
                "description": "(Optional) String\nUnit of time between data points. Can be `day` or `hour`, defaults to `day`. "
              },
              {
                "name": "app_id",
                "value": "{{app_identifier}}",
                "type": "query",
                "description": "(Optional) String\nApp API identifier retrieved from the Settings > Setup and Testing > API Keys to limit analytics to a specific app."
              },
              {
                "name": "product",
                "value": "name",
                "type": "query",
                "description": "(Optional) String\nName of product to filter response by. If excluded, results for all apps will be returned."
              }
            ]
          },
          "docs": "> Use this endpoint to return the total number of purchases in your app over a time range. \n  \n\nTo use this endpoint, youll need to generate an API key with the `purchases.quantity_series` permission.\n\n## Rate limit\n\nFor customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/events/list` endpoint, as documented in [API rate limits](https://www.braze.com/docs/api/api_limits/)"
        },
        {
          "info": {
            "name": "Export Revenue Data by Time",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.iad-01.braze.com/purchases/revenue_series",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer {{api_key}}"
              }
            ],
            "params": [
              {
                "name": "ending_at",
                "value": "2018-06-28T23:59:59-5:00",
                "type": "query",
                "description": "(Optional) Datetime (ISO 8601 string)\nDate on which the data series should end. Defaults to time of the request."
              },
              {
                "name": "length",
                "value": "100",
                "type": "query",
                "description": "(Required) Integer\nMaximum number of days before ending_at to include in the returned series. Must be between 1 and 100 (inclusive)."
              },
              {
                "name": "unit",
                "value": "14",
                "type": "query",
                "description": "(Optional) String\nUnit of time between data points. Can be `day` or `hour`, defaults to `day`. "
              },
              {
                "name": "app_id",
                "value": "{{app_identifier}}",
                "type": "query",
                "description": "(Optional) String\nApp API identifier retrieved from the Settings > Setup and Testing > API Keys to limit analytics to a specific app."
              },
              {
                "name": "product",
                "value": "name",
                "type": "query",
                "description": "(Optional) String\nName of product to filter response by. If excluded, results for all apps will be returned."
              }
            ]
          },
          "docs": "> Use this endpoint to return the total money spent in your app over a time range. \n  \n\nTo use this endpoint, youll need to generate an API key with the `purchases.revenue_series` permission.\n\n## Rate limit\n\nFor customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/events/list` endpoint, as documented in [API rate limits](https://www.braze.com/docs/api/api_limits/).\n\n## Exa"
        }
      ]
    }
  ],
  "bundled": true
}