{"componentChunkName":"component---src-templates-markdown-template-jsx","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/user-segments-export-api/","result":{"data":{"pageMetadata":{"title":"User Segments Export API (Deprecated)","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/user-segments-export-api/","sourceCode":null,"metadataParent":{"title":"APIs","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/","sourceCode":null,"hasVersionPicker":null,"metadataChildren":[{"title":"Dashboard Filter API (Deprecated)","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/dashboard-filter-api/","order":6.1,"label":null},{"title":"REST API","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/rest-api/","order":6.1,"label":null},{"title":"User Segments Export API (Deprecated)","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/user-segments-export-api/","order":6.3,"label":null}],"metadataParent":{"title":"Developer Docs","path":"/guides/analytics/analytics-deprecated/developer-docs/","metadataChildren":[{"title":"Introduction","path":"/guides/analytics/analytics-deprecated/developer-docs/introduction/","order":1,"label":null},{"title":"Integrations","path":"/guides/analytics/analytics-deprecated/developer-docs/integrations/","order":4,"label":null},{"title":"Data Warehouses and Data Lakes","path":"/guides/analytics/analytics-deprecated/developer-docs/data-warehouses-lakes/","order":5,"label":null},{"title":"APIs","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/","order":6,"label":null},{"title":"SDKs","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/","order":6,"label":null},{"title":"Developer Basics","path":"/guides/analytics/analytics-deprecated/developer-docs/developer-basics/","order":7,"label":null}],"metadataParent":{"title":"Analytics (Deprecated)","path":"/guides/analytics/analytics-deprecated/","metadataChildren":[{"title":"Introduction","path":"/guides/analytics/analytics-deprecated/introduction/","order":1.1,"label":null},{"title":"Developer Docs","path":"/guides/analytics/analytics-deprecated/developer-docs/","order":4,"label":null},{"title":"Identity Providers","path":"/guides/analytics/analytics-deprecated/identity-providers/","order":null,"label":null},{"title":"Settings","path":"/guides/analytics/analytics-deprecated/settings/","order":null,"label":null}],"metadataParent":{"title":"Analytics","path":"/guides/analytics/","metadataChildren":[{"title":"Introduction","path":"/guides/analytics/introduction/","order":1,"label":null},{"title":"Core Analytics (Beta)","path":"/guides/analytics/core-analytics/","order":1.1,"label":null},{"title":"Analytics Free Trial","path":"/guides/analytics/analytics-free-trial/","order":2,"label":null},{"title":"Setup","path":"/guides/analytics/setup/","order":3,"label":null},{"title":"Settings","path":"/guides/analytics/settings/","order":4,"label":null},{"title":"Analytics Data Manager","path":"/guides/analytics/data-manager/","order":5,"label":null},{"title":"Analyses","path":"/guides/analytics/analyses/","order":6,"label":null},{"title":"Query Builder","path":"/guides/analytics/query-builder/","order":6,"label":null},{"title":"User Aliasing","path":"/guides/analytics/user-aliasing/","order":7,"label":null},{"title":"Dashboards","path":"/guides/analytics/dashboards/","order":8,"label":null},{"title":"Analytics Resources","path":"/guides/analytics/resources/","order":10,"label":null},{"title":"User Segments","path":"/guides/analytics/user-segments/","order":10,"label":null},{"title":"Tutorials","path":"/guides/analytics/tutorials/","order":11,"label":null},{"title":"APIs","path":"/guides/analytics/apis/","order":12,"label":null},{"title":"Analytics (Deprecated)","path":"/guides/analytics/analytics-deprecated/","order":13,"label":null}],"metadataParent":{"title":"Guides","path":"/guides/","metadataChildren":[{"title":"Platform Overview","path":"/guides/platform-overview/","order":0.5,"label":null},{"title":"Getting Started","path":"/guides/getting-started/","order":1,"label":null},{"title":"mParticle Agent","path":"/guides/mparticle-agent/","order":1.5,"label":null},{"title":"Oversight","path":"/guides/oversight/","order":2,"label":null},{"title":"Data Platform","path":"/guides/data-platform/","order":3,"label":null},{"title":"Data Warehouse","path":"/guides/data-warehouse/","order":4,"label":null},{"title":"Customer 360","path":"/guides/customer-360/","order":5,"label":null},{"title":"Analytics","path":"/guides/analytics/","order":6,"label":null},{"title":"Audiences","path":"/guides/audiences/","order":7,"label":null},{"title":"Settings","path":"/guides/settings/","order":8,"label":null},{"title":"Troubleshooting mParticle","path":"/guides/troubleshooting/","order":10,"label":null},{"title":"Default Service Limits","path":"/guides/default-service-limits/","order":11,"label":null},{"title":"Glossary","path":"/guides/glossary/","order":12,"label":null}]}}}}}},"markdownRemark":{"html":"\n

One of the most powerful pieces of functionality Analytics offers is the ability to identify groups of users based on their behavioral characteristics. These groups are known in Analytics as User Segments. This functionality is now available as an API so that you can programmatically export segments for use within your own or third-party platforms.

\n

\n \n \n \n \n \n \n \n Introduction

\n

Almost any data point in Analytics can be saved as a User Segment. For example, if you run a segmentation query representing Registrations in the Last 7 Days, you can save the output of that query as a User Segment named Recent Registrants, which will contain all users who performed a Registration event in the Last 7 Days. Once these User Segments are built, they can be used as filters in all other queries. Continuing on the above example, you would be able to filter any analysis based on whether users included in that analysis are in (or not in) the Recent Registrants set of users.

\n

Using Analytics’ User Segments Export API, you will be able to export your User Segments for use in downstream systems.

\n

Analytics’ Export API is accessible only to Pro or Enterprise customers.

\n

\n \n \n \n \n \n \n \n Overview

\n

The User Segments Export API is an asynchronous API. Upon invoking a request for a User Segments export, Analytics will schedule a job to asynchronously process and upload the final result to Amazon S3, where you’ll then be able to download the file to access the contents.

\n

Analytics’ User Segments Export API allows you to perform three operations related to User Segment exports:

\n\n

User Segment exports typically complete within a matter of seconds, but can potentially take up to several hours to complete with a large result set.

\n

The expected usage of this API works as follows:

\n
    \n
  1. List your User Segments and identify the User Segment you would like to export.
    2. \n
  2. Submit a request to export a User Segment by passing in the unique identifier of the User Segment from the prior step. You will receive an Export Request Token uniquely identifying your export request.
    3. \n
  3. Poll Analytics’ API using your Export ID. Once the upload has been completed, the API response will include a successful status and a URL to a file in Amazon S3 containing the users in your User Segment.
    4. \n
  4. Download the newly uploaded file in S3.
    5. \n
\n

\n \n \n \n \n \n \n \n Common Requests and Response

\n

\n \n \n \n \n \n \n \n Authentication

\n

Analytics’ Export API requires HTTPS/SSL and uses Basic Authentication header for all requests. Basic Authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a Base64-encoded string username:password.

\n

Use your API Key as the username and your Access Token as the password. This information can be found on the Project Page in the Analytics web application. Please treat your Access Token as you would a password, as it is meant to only be known to you.

\n

An example curl:\ncurl -v -u "apiKey:accessToken" https://query.indicative.com

\n

curl’s -u parameter automatically encodes the username and password and inserts them into the Authorization header. Depending on your client implementation you may need to do this manually.

\n

The resulting HTTP Response should have a 200 OK status.

\n

\n \n \n \n \n \n \n \n Response Format

\n

All API responses are in JSON format.

\n

\n \n \n \n \n \n \n \n Common Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Status CodeDescription
200Success: Your request was successful.
401Unauthorized: Your request was rejected because we could not validate your credentials. Please check that your API key and access token are correct.
403Forbidden: Your request was rejected because the specified project does not have access to the Export API. Please upgrade your account or contact Analytics support to gain access.
429Too Many Requests: Too many requests have been attempted in a given amount of time.
500Internal Error: An error occurred while processing your API request. This will automatically raise a ticket with the Analytics team. Please try your request at a later time.
\n

\n \n \n \n \n \n \n \n Endpoints

\n

\n \n \n \n \n \n \n \n List User Segments

\n

This endpoint lists all User Segments in a project.

\n\n

User Segment Object Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeNullable?Description
segmentIdStringNoThe unique ID of the User Segment.
nameStringNoThe human-readable name of the User Segments.
descriptionStringYesThe human-readable description of the User Segments.
categoryStringYesThe human-readable category of the User Segments.
projectIdStringNoThe project ID associated to the segment ID.
typeEnumNoThe type of the user segment, either Static (One-time in the UI) or Dynamic (Daily in the UI). Static segments never change while Dynamic segments may be refreshed.
lastRunDateTimeYesThe timestamp of the last refresh of the User Segments.
\n

Example: List User Segments

\n

$ curl -s -u "5a6646c4-ae5a-4de4-9d47-eb6f228405b2:nux06hkn870v0ni4fhtd81kf" https://query.indicative.com/service/v1/segments/list

\n
[\n  {\n    "segmentId": "82200474-c131-4f7b-a35e-381469af31a7",\n    "name": "My Segment",\n    "description": "This is my segment",\n    "category": null,\n    "projectId": "5a6646c4-ae5a-4de4-9d47-eb6f228405b2",\n    "type": "Static",\n    "lastRun": "2019-04-09T12:25:06.000Z"\n  }\n]
\n

\n \n \n \n \n \n \n \n Request a User Segment Export

\n

This endpoint invokes a new export request for the specified User Segments.

\n\n

\n \n \n \n \n \n \n \n Export Status Object Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeNullable?Description
exportIdStringNoThe unique ID of the User Segment export request.
segmentObjectNoAn object encapsulating information about the target User Segment for this export.
statusEnumNoThe status of the User Segment export. Values are either PENDING, COMPLETE, or FAILED.
projectIdStringNoThe project ID of the User Segment export.
startTimeDateTimeNoThe time at which the User Segment export started.
endTimeDateTimeYesThe time at which the User Segment export completed. This field will remain null until the export is completed.
filenameStringNoThe fully qualified location of the file to download.
\n

Example: Request User Segments Export

\n
$ curl -s -u "5a6646c4-ae5a-4de4-9d47-eb6f228405b2:nux06hkn870v0ni4fhtd81kf" -H 'Content-Type: application/json' https://query.indicative.com/service/v1/segments/export/ -d'{\n  "segmentId": "82200474-c131-4f7b-a35e-381469af31a7",\n  "outputFormat": "csv"\n}'
\n
{\n  "exportId": "8f9fdd71-204c-41e1-a2ab-de7f85002f65",\n  "segment": {\n    "segmentId": "82200474-c131-4f7b-a35e-381469af31a7",\n    "name": "My Segment",\n    "description": "This is my segment",\n    "category": null,\n    "projectId": "5a6646c4-ae5a-4de4-9d47-eb6f228405b2",\n    "type": "Static",\n    "lastRun": "2019-04-09T12:25:06.000Z"\n  },\n  "status": "PENDING",\n  "startTime": "2019-04-09T14:45:07.000Z",\n  "endTime": null,\n  "filename": null\n}
\n

\n \n \n \n \n \n \n \n Check Export Status

\n

This endpoint checks the status of a previously submitted export request. Once the request has finished processing, it will include a URL to download the results.

\n

Once the request has been completed, the file will remain in Amazon for no more than 48 hours. Otherwise, a new request must be submitted.

\n\n

Example: Check User Segment Export Status

\n

$ curl -s -u "5a6646c4-ae5a-4de4-9d47-eb6f228405b2:nux06hkn870v0ni4fhtd81kf" https://query.indicative.com/service/v1/segments/export/8f9fdd71-204c-41e1-a2ab-de7f85002f65

\n
{\n  "exportId": "8f9fdd71-204c-41e1-a2ab-de7f85002f65",\n  "segment": {\n    "segmentId": "82200474-c131-4f7b-a35e-381469af31a7",\n    "name": "My Segment",\n    "description": "This is my segment",\n    "category": null,\n    "projectId": "5a6646c4-ae5a-4de4-9d47-eb6f228405b2",\n    "type": "Static",\n    "lastRun": "2019-04-09T12:25:06.000Z"\n  },\n  "status": "COMPLETE",\n  "startTime": "2019-04-09T14:45:07.000Z",\n  "endTime": "2019-04-09T14:45:42.000Z",\n  "filename": "s3://upload-bucket/path/to/8f9fdd71-204c-41e1-a2ab-de7f85002f65.csv"\n}
","frontmatter":{"title":"User Segments Export API (Deprecated)","order":6.3,"seoTitle":null,"seoDescription":null},"parent":{"__typename":"File","modifiedTime":"October 12, 2026"}}},"pageContext":{"slug":"/guides/analytics/analytics-deprecated/developer-docs/apis/user-segments-export-api/"}},"staticQueryHashes":["2950460867"]}