--- openapi: 3.0.3 info: title: Braze REST API – Export segment analytics description: | ## Prerequisites To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key-permissions) with the `segments.data_series` permission. ## Rate limit We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/). version: 1.0.0 contact: name: Braze Support url: https://www.braze.com/docs/braze_support/ license: name: Braze Documentation url: https://www.braze.com/docs/api/home/ servers: - url: https://rest.iad-01.braze.com description: US-01 - url: https://rest.iad-02.braze.com description: US-02 - url: https://rest.iad-03.braze.com description: US-03 - url: https://rest.iad-04.braze.com description: US-04 - url: https://rest.iad-05.braze.com description: US-05 - url: https://rest.iad-06.braze.com description: US-06 - url: https://rest.iad-07.braze.com description: US-07 - url: https://rest.iad-08.braze.com description: US-08 - url: https://rest.us-10.braze.com description: US-10 - url: https://rest.fra-01.braze.eu description: EU-01 - url: https://rest.fra-02.braze.eu description: EU-02 - url: https://rest.au-01.braze.com description: AU-01 - url: https://rest.id-01.braze.com description: ID-01 - url: https://rest.jp-01.braze.com description: JP-01 - url: https://rest.kr-01.braze.com description: KR-01 security: - BearerAuth: [] paths: "/segments/data_series": get: summary: Export segment analytics operationId: get_segments_data_series_get_segment_analytics parameters: - name: segment_id in: query required: true description: | See [Segment API identifier]({{site.baseurl}}/api/identifier_types/). The `segment_id` for a given segment can be found on the [API Keys]({{site.baseurl}}/user_guide/administer/global/workspace_settings/apis_and_identifiers/) page within your Braze account or you can use the [Export segment list endpoint]({{site.baseurl}}/api/endpoints/export/segments/get_segment/). schema: type: string example: segment_identifier - name: length in: query required: true description: Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). schema: type: integer minimum: 1 maximum: 100 example: 14 - name: ending_at in: query required: false description: | Date on which the data series should end. Defaults to time of the request. Pass a datetime as an [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string. schema: type: string format: date-time example: "2018-06-27T23:59:59-5:00" responses: "200": description: | The request succeeded and the response body includes the requested data. No action needed. The following sample response shows an example of the response returned when you export segment analytics. content: application/json: schema: $ref: '#/components/schemas/SegmentAnalyticsResponse' examples: success: summary: Segment size series value: message: success data: - time: "2018-06-26" size: 1000 - time: "2018-06-27" size: 1050 "400": description: | Bad request. To resolve it: - **The `segment_id` is missing or isn't a valid segment API identifier:** Pass a valid `segment_id`. Find it with the [Export segment list endpoint]({{site.baseurl}}/api/endpoints/export/segments/get_segment/). - **The `length` is missing, isn't an integer, or is out of range:** Pass an integer `length` between 1 and 100. - **The `ending_at` value is improperly formatted or out of range:** Provide `ending_at` as an ISO-8601 datetime that isn't in the future or before the year 2000. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_segment_id: summary: Missing or invalid segment_id value: message: segment_id must be a string that is a valid segment api identifier missing_length: summary: Missing or non-integer length value: message: an integer length must be provided length_out_of_range: summary: Length out of range value: message: series range must be greater than 0 and less than 100 ending_at_format: summary: Improperly formatted ending_at value: message: ending_at time is improperly formatted ending_at_out_of_range: summary: ending_at out of range value: message: ending_at time is out of range "401": description: | Unauthorized. The REST API key is missing, malformed, or sent to the wrong REST endpoint. Send the key as `Authorization: Bearer YOUR_REST_API_KEY` to the correct [REST endpoint]({{site.baseurl}}/api/basics/#endpoints). For more causes, see [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_api_key: summary: Invalid API key value: message: 'Invalid API key: YOUR_REST_API_KEY' "403": description: Access denied. The REST API key doesn't have the required permission. Use a REST API key that has the `segments.data_series` permission. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: access_denied: summary: Missing permission value: message: Access Denied "429": description: | Rate limited. You exceeded the rate limit for this endpoint. Slow your request rate and retry with exponential backoff. See [API rate limits]({{site.baseurl}}/api/api_limits/). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: over_rate_limit: summary: Over rate limit value: message: You have exceeded your limit of 250000 requests per hour. Please contact your account executive to increase your limit. If you do not have their info, you may contact Braze directly at https://www.braze.com/contact/. 5XX: description: | Internal server error. An unexpected error occurred on the Braze server. Retry with exponential backoff. If the error persists, contact [Support]({{site.baseurl}}/braze_support/). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: REST API key description: | REST API keys are created in the Braze dashboard at **Settings → APIs and Identifiers → API Keys**. The key must include the `segments.data_series` permission. Pass the key as `Authorization: Bearer YOUR_REST_API_KEY`. schemas: SegmentSizeDataPoint: title: Segment size data point type: object properties: time: type: string description: The date as ISO 8601 date. example: "2018-06-27" size: type: integer description: The size of the segment on that date. example: 1050 SegmentAnalyticsResponse: title: Export segment analytics response type: object properties: message: type: string description: Returns 'success' when the request completes without errors. example: success data: type: array items: $ref: '#/components/schemas/SegmentSizeDataPoint' ErrorResponse: title: Error type: object properties: message: type: string description: The error message describing why the request failed. errors: type: array description: Non-fatal errors encountered while processing the request. Data unaffected by these errors is still processed. items: type: object properties: type: type: string description: The error type.