Supported Endpoints & Parameters
This topic is for the single-tenant environment (STE) version of Bulk Data Export. If your implementation is a multi-tenant environment (MTE), see the topics in Bulk Data Export (Multi Tenant).
You can use the following endpoints and search parameters for the 1up Bulk Data Export process.
Supported Endpoints
1up Bulk Data Export includes the following endpoints, each for a different portion of the Bulk Data Export process.
|
Endpoint |
Description |
URL |
|---|---|---|
|
Create the export job and start the export process. Provides the URL for the Status endpoint. |
User ID or client ID: Group: |
|
|
Get the status of the Export operation using the job ID. Provides the list of exported files. |
User ID, client ID, or group: |
|
|
Download the exported files. |
https://analytics.{baseURL}/bulk-data/r4/$export/file/xxxxx.ndjson |
Search Parameters
You can apply the following search parameters to your request to filter the results by resource type or date.
|
Parameter |
Description |
Format |
|---|---|---|
|
|
Specify the types of resources to include in the response. For group-level exports, Example — |
User ID or client ID: User ID example: Group: Group example: |
|
|
Resources are included in the response if their state has changed after the specified date. Example — You can also specify the date and time values for the Example — |
analytics.{baseURL}/bulk-data/r4/Group/{id}/$export?_since=YYYY-MM-DD Example: |
