Was this helpful?

 

Apigee Edge Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/stats/customaggregates

Description: Returns the list of custom aggregates. Use the status query parameter to cutomize the list.

Verb: GET
Auth: Basic Auth
Media types:
application/json

For more information on custom aggregates, see Use custom aggregations.

Query Parameters:
 
Name Value Description Default Required?
expand true or false If true, returns an expanded description of the custom aggregate. false No
status active, inactive, or all

active: Returns only active custom aggregates.

inactive: Returns inactive custom aggregates which are not 15 days old.

all: Returns all custom aggregates active and inactive.

 

all No
Sample Response (not expanded):
{
    "custom_aggregates": [
        {
            "displayName": "my_custom_agg_2",
            "name": "my_custom_agg_250c1e623-e559-46b5-953e-bb532c245d3e",
            "status": "active"
        },
        {
            "displayName": "my_custom_agg",
            "name": "my_custom_agg28ffe3b5-9b9d-4984-af0e-51b4b9fed8ef",
            "status": "active"
        }
    ]
}
Sample Response (expanded):
{
    "custom_aggregates": [
        {
            "createdAt": 1387195927616,
            "createdBy": "ntesla@example.com",
            "descriptions": "This is the description.",
            "dimensions": [
                "apiproxy",
                "developer_app"
            ],
            "displayName": "my_custom_agg_2",
            "env": "test",
            "filter": "(iserror eq 1)",
            "lastModifiedAt": 1387197031722,
            "metrics": [
                "total_response_time",
                "message_count"
            ],
            "name": "my_custom_agg_250c1e623-e559-46b5-953e-bb532c245d3e",
            "status": "active"
        },
        {
            "createdAt": 1387195312650,
            "createdBy": "ntesla@example.com",
            "descriptions": "This is the description.",
            "dimensions": [
                "apiproxy",
                "developer_app"
            ],
            "displayName": "my_custom_agg",
            "env": "test",
            "filter": "(iserror eq 1)",
            "lastModifiedAt": 1387195312650,
            "metrics": [
                "total_response_time",
                "message_count"
            ],
            "name": "my_custom_agg28ffe3b5-9b9d-4984-af0e-51b4b9fed8ef",
            "status": "active"
        }
    ]
}
Response Payload Elements:
Name Description
name

The unique name of the custom aggregate. 

Error codes

  • 500 Server Error: If the database is down or any other internal error.

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)