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 anlytics data export job (Beta)

Resource Summary

Security

Content Type

application/json, text.xml

Category

Analytics,

Createananlyticsdataexportjob

POST

Create an anlytics data export job (Beta)

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.

 

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.

 

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.

 

Note: You are limited to 50 data exports per rolling 30-day window per organziation type (monetization or non-monetization). That limit corresponds to making 50 POST API calls to intitiate a data export for a monetization-enabled org, and 50 for a non-monetization org.

 

See Export data from Analytics for more information and examples.

 

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