Analytics API
Use Apigee Edge Analytics.
Resource Types
Export
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org_name}/environments/{env_name}/analytics/exports | Gets a list of all analytics data export jobs created for an organization and environment. The response provides links to get status of individual jobs. See Export data from Analytics for more information and examples. |
post | /organizations/{org_name}/environments/{env_name}/analytics/exports | Creates an analytics data export job. The API returns the data export job ID 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 Apigee pricing plans. To export data from an organization that supports monetization, specify 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:
If you exceed the call quota, this API returns an |
get | /organizations/{org_name}/environments/{env_name}/analytics/exports/{export_id} | Gets the status of an analytics data export job. Create an export job using the Create an analytics data export job API. The See Export data from Analytics for more information and examples. |
ExportRequest
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org_name}/environments/{env_name}/analytics/exports | Creates an analytics data export job. The API returns the data export job ID 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 Apigee pricing plans. To export data from an organization that supports monetization, specify 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:
If you exceed the call quota, this API returns an |
Query
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org_name}/environments/{env_name}/queries | Lists the asynchronous analytics queries for an environment. |
post | /organizations/{org_name}/environments/{env_name}/queries | Creates an asynchronous analytics query. You must be an organization administrator to call this API. You can make up to seven calls per hour to this API. If you exceed the call quota, this API returns an Note: Free and trial accounts cannot create asynchronous reports. For more information on Edge pricing plans, see Apigee pricing plans. See Use the asynchronous custom reports API for more information and examples. |
get | /organizations/{org_name}/environments/{env_name}/queries/{queryId} | Gets the status of an asynchronous analytics query.
Obtain the In the response, the value of the state property contains the query status as either See Use the asynchronous custom reports API for more information and examples. |
QueryRequest
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org_name}/environments/{env_name}/queries | Creates an asynchronous analytics query. You must be an organization administrator to call this API. You can make up to seven calls per hour to this API. If you exceed the call quota, this API returns an Note: Free and trial accounts cannot create asynchronous reports. For more information on Edge pricing plans, see Apigee pricing plans. See Use the asynchronous custom reports API for more information and examples. |