{
  "opencollection": "1.0.0",
  "info": {
    "name": "Braze Export > Segment API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Export > Segment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Export Segment List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.iad-01.braze.com/segments/list",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer {{api_key}}"
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "(Optional) Integer\n\nThe page of segments to return, defaults to 0 (returns the first set of up to 100)."
              },
              {
                "name": "sort_direction",
                "value": "desc",
                "type": "query",
                "description": "(Optional) String\n\n- Sort creation time from newest to oldest: pass in the value `desc`.\n- Sort creation time from oldest to newest: pass in the value `asc`.\n\nIf `sort_direction` is not included, the default order is oldest to newest."
              }
            ]
          },
          "docs": "> Use this endpoint to export a list of segments, each of which will include its name, Segment API identifier, and whether it has analytics tracking enabled. \n  \n\nThe segments are returned in groups of 100 sorted by time of creation (oldest to newest by default). Archived segments are not included.\n\nTo use this endpoint, youll need to generate an API key with the `segments.list` permission.\n\n### Rate limit\n\nWe apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as d"
        },
        {
          "info": {
            "name": "Export Segment Analytics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.iad-01.braze.com/segments/data_series",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer {{api_key}}"
              }
            ],
            "params": [
              {
                "name": "segment_id",
                "value": "{{segment_identifier}}",
                "type": "query",
                "description": "(Required) String\n\nSee [Segment API identifier](https://www.braze.com/docs/api/identifier_types/).\n\nThe `segment_id` for a given segment can be found in your **Settings > Setup and Testing > API Keys.** within your Braze account or you can use the [Segment List Endpoint](https://www.braze.com/docs/api/endpoints/export/get_segment/)."
              },
              {
                "name": "length",
                "value": "14",
                "type": "query",
                "description": "(Required) Integer\n\nMax number of days before `ending_at` to include in the returned series - must be between 1 and 100 (inclusive)."
              },
              {
                "name": "ending_at",
                "value": "2018-06-27T23:59:59-5:00",
                "type": "query",
                "description": "(Optional) Datetime ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string)\n\nDate on which the data series should end. Defaults to time of the request."
              }
            ]
          },
          "docs": "> Use this endpoint to retrieve a daily series of the estimated size of a segment over time. \n  \n\nNote: If you are using our [older navigation](https://www.braze.com/docs/navigation), `segment_id` can be found at **Developer Console > API Settings**.\n\nTo use this endpoint, youll need to generate an API key with the `segments.data_series` permission.\n\n### Rate limit\n\nWe apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in [API rate limits](https://www"
        },
        {
          "info": {
            "name": "Export Segment Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.iad-01.braze.com/segments/details",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer {{api_key}}"
              }
            ],
            "params": [
              {
                "name": "segment_id",
                "value": "{{segment_identifier}}",
                "type": "query",
                "description": "(Required) String\n\nSee [Segment API identifier](https://www.braze.com/docs/api/identifier_types/).\n\nThe `segment_id` for a given segment can be found in your **Settings > Setup and Testing > API Keys** within your Braze account or you can use the [Segment List Endpoint](https://www.braze.com/docs/api/endpoints/export/get_segment/)."
              }
            ]
          },
          "docs": "> Use this endpoint to retrieve relevant information on a segment, which can be identified by the `segment_id`. \n  \n\nNote: If you are using our [older navigation](https://www.braze.com/docs/navigation), `segment_id` can be found at **Developer Console > API Settings**.\n\nTo use this endpoint, youll need to generate an API key with the `segments.details` permission.\n\n## Rate limit\n\nWe apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in [API rate limit"
        }
      ]
    }
  ],
  "bundled": true
}