Was this helpful?

 

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

API Resource Path:

/stats/customaggregates/{custom_agg_name}

Description: Activates (restarts) an inactive custom aggregate. Supply the custom aggregate's name in the URL. 

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

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

Sample Request:

$ curl -H "Content-type:application/json" -X PUT -d \
'{
“status” : “active”
}'  \
https://api.enterprise.apigee.com/v1/o/stats/customaggregates/{custom_agg_name} \
-u myname:mypass
Request Payload Elements:
 
Name Description
status Set to "active" for this use case. 
Sample Response:
{
    "displayName": "custom_agg1",
    “name”:”custom_agg1_uuid”,
    "status": "active",
    “descriptions” : “This is a description.”,
    “env”:”test”,
    "metrics": [
        "response_time",
        "message_count"
    ],
    "dimensions": [
        "is_error",
        "apiproxy",
        "developer_app"
    ],
    "filter":"(apiproxy in \"api1\",\"api2\",\"api3\") or (iserror eq 1)",
     “createdBy”:”ntesla@example.com”,
     “createdAt”:21627162
     “lastModifiedAt”:3728392
}
Response Payload Elements:
Name Description
status Returns "active" for this use case. 

Error codes

  • 404 Not Found: If you try to activate a custom aggregate that does not exist.
  • 403: If the custom aggregate is inactive for more than 30 days.
  • 500 Server Error: If the database is down or any other internal error occurs.

 

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