You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

Create an analytics data export job

Resource Summary

Security

Content Type

application/json, text.xml

Category

Analytics,

Createananlyticsdataexportjob

POST

Create an analytics data export job

Creates a new analytics data export job using the export job definition in the payload and returns the exportId that you use to track the status of the job. You must be in the role of organization administrator to call this API.

 

Note: Free and trial accounts cannot export analytics data. For more information on Edge pricing plans, see https://apigee.com/api-management/#/pricing.

 

The dateRange property specifies the start and end date of the data to export, in the format yyyy-mm-dd. For example:

 

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

 

The dateRange value can only span one day. The date range begins at 00:00:00 UTC on the start date and ends at 00:00:00 UTC on the end date.

 

The dataStore_name property specifies the name of the data store that defines the connection to your export data repository (GCS, BigQuery), including the credentials used to access the data repository. You must first create the data store in the Edge UI. See Create a data store for more.

 

To export data from an org that supports monetization, specify "dataset":"mint". The org must support monetization to set this option, otherwise omit the "dataset" property from the payload.

 

See Export data from Analytics for more information and examples.

 

Export API quotas

To prevent overuse of expensive data export API calls, Edge enforces a quota on calls to this API:

  • For organizations and environments that do not have monetization enabled, the quota is:
    • 70 calls per month per organization/environment. 

For example, if you have two environments in your org, prod and test, you can make 70 API calls per month for each environment.
 

  • For organizations and environments with monetization enabled, the quota is:
    • 70 calls per month for each organization and environment for standard data.
    • 70 calls per month for each organization and environment for monetization data.

For example, if you enable monetization on your prod org, you can make 70 API calls for standard data and 70 additional API calls for monetization data.

 

 

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/analytics/exports

Request Body

Property Description Required?
description Description of the export request. No
name Name of the export request. Yes
dateRange

Specify the start and end date of the data to export, in the format yyyy-mm-dd. For example:

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

The dateRange value can only span one day. The date range begins at 00:00:00 UTC on the start date and ends at 00:00:00 UTC on the end date.

Yes
outputFormat Specify as either json or csv. Yes
csvDelimiter

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

No
datastoreName The name of the data store containing the definition of your data store. The data store defines the connection to your export data repository (GCS, BigQuery), including the credentials used to access the data repository. You must create the data store in the Edge UI. See Create a data store for more. Yes
dataset To export data from an org that supports monetization, specify "dataset":"mint". The org must support monetization to set this option, otherwise omit the "dataset" property. Yes for an org that enables monetization

org_name Mention the organization name true

env_name Mention the environment name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)