In November 2020, the Apigee Edge API reference documentation will move to a new experience based on the Apigee integrated portal and visitors to this site will be redirected.

You are viewing the Apigee Edge API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Analytics


Base Path: https://api.enterprise.apigee.com/v1/analytics/groups/{group_name}/scopes 

API Resource Path: /analytics/groups/{group_name}/scopes
API proxies for Edge analytics.

Apigee Edge exposes a RESTful API that enables you to work with Edge analytics.

Remove analytics information about an environment Detail
/analytics/groups/{group_name}/scopes
Verb: DELETE
Description: Removes analytics information about an environment.
Media types:
 
Auth: Basic Auth
Enable analytics for an environment Detail
organizations/{org_name}/environments/{env_name}/analytics/admin
Verb: POST
Description: Enables analytics for an environment.
Media types:
application/json
Auth: Basic Auth
Create an anlytics data export job Detail
organizations/{org_name}/environments/{env_name}/analytics/exports
Verb: POST
Description: Creates a new analytics data export job using the export job definition in the payload.
Media types:
application/json, text/xml
Auth: Basic Auth
Get a list of analytics data export jobs Detail
organizations/{org_name}/environments/{env_name}/analytics/exports
Verb: GET
Description: Gets a list of all analytics data export jobs created for an organization and envrinment..
Media types:
application/json, text/xml
Auth: Basic Auth
Get analytics data export job status Detail
organizations/{org_name}/environments/{env_name}/analytics/exports/{exportId}
Verb: GET
Description: Get the status the analytics data export job for a specific exportId.
Media types:
application/json, text/xml
Auth: Basic Auth
Create an asynchronous analytics query Detail
organizations/{org_name}/environments/{env_name}/queries
Verb: POST
Description: Create an asynchronous analytics query.
Media types:
application/json, text/xml
Auth: Basic Auth
Get status of an asynchronous analytics query Detail
organizations/{org_name}/environments/{env_name}/queries/{query_id}
Verb: GET
Description: Get the status of an asynchronous analytics query.
Media types:
application/json, text/xml
Auth: Basic Auth
Get result of an asynchronous analytics query Detail
organizations/{org_name}/environments/{env_name}/queries/{query_id}/result
Verb: GET
Description: Get result of an asynchronous analytics query.
Media types:
application/json, text/xml
Auth: Basic Auth
Get a list of asynchronous analytics queries Detail
organizations/{org_name}/environments/{env_name}/queries
Verb: GET
Description: Get a list of asynchronous analytics queries.
Media types:
application/json, text/xml
Auth: Basic Auth

 

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