Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of "enqueued".

post/v1/{+parent}/analytics/exports

Path parameters

parentstring required

Required. Names of the parent organization and environment. Must be of the form organizations/{org}/environments/{env}.

Request body

csvDelimiterstring

Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).

datastoreNamestring

Required. Name of the preconfigured datastore.

namestring

Required. Display name of the export job.

outputFormatstring

Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.

descriptionstring

Optional. Description of the export job.

Response

Successful response