Method: organizations.environments.analytics.exports.create

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".

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*}/analytics/exports

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.exports.create

Request body

The request body contains an instance of ExportRequest.

Response body

If successful, the response body contains a newly created instance of Export.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

ExportRequest

Request body for [CreateExportRequest]

JSON representation
{
  "name": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "outputFormat": string,
  "csvDelimiter": string,
  "datastoreName": string
}
Fields
name

string

Required. Display name of the export job.

description

string

Optional. Description of the export job.

dateRange

object (DateRange)

Required. Date range of the data to export.

outputFormat

string

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.

csvDelimiter

string

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).

datastoreName

string

Required. Name of the preconfigured datastore.

DateRange

Date range of the data to export.

JSON representation
{
  "start": string,
  "end": string
}
Fields
start

string

Required. Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.

end

string

Required. End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.