Skip to main content

exports

Overview

Nameexports
TypeResource
Idgoogle.apigee.exports

Fields

NameDatatypeDescription
namestringDisplay name of the export job.
descriptionstringDescription of the export job.
createdstringOutput only. Time the export job was created.
datastoreNamestringName of the datastore that is the destination of the export job [datastore]
errorstringOutput only. Error is set when export fails
executionTimestringOutput only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
selfstringOutput only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
statestringOutput only. Status of the export job. Valid values include enqueued, running, completed, and failed.
updatedstringOutput only. Time the export job was last updated.

Methods

NameAccessible byRequired ParamsDescription
organizations_environments_analytics_exports_getSELECTenvironmentsId, exportsId, organizationsIdGets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.
organizations_environments_analytics_exports_listSELECTenvironmentsId, organizationsIdLists the details and status of all analytics export jobs belonging to the parent organization and environment.
organizations_environments_analytics_exports_createINSERTenvironmentsId, organizationsIdSubmit 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".