Retrieve daily execution metrics
GET /runtime/api-stats/{env_org}/daily?{query_parameters}
Overview
This API retrieves the daily metrics of pipeline executions on the specified date.
Prerequisites
- Environment (Org) admin permissions
Request
GET https://{controlplane_path}/api/1/rest/public/runtime/api-stats/{env_org}/daily?{query_parameters}
Path Parameters
Key | Description |
---|---|
controlplane_path |
Required. The path to the SnapLogic Control Plane:
elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic . For
example:
|
env_org |
Required. The name of the SnapLogic environment/Org.
For example, My-Dev-Env |
Query Parameters
Key | Type | Description |
---|---|---|
date |
string | The date in UTC format (YYYY-MM-DD ).
|
Request Header
Specify Basic
for authorization and application/json
for content type.
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request Body
None.
Response
Response Body
Note:
The results include only the pipeline executions that you have permissions to view.
Environment/Org admins can view all pipeline executions.
{
"response_map": {
"date": "...",
"organization": "...",
"top_tasks": [
{
"task_id": "...",
"task_name": "...",
"task_path": "...",
"task_owner": "...",
"api_count": ...
}
],
"task_count": ...,
"daily_call_used": ...,
"daily_call_available": ...
},
"http_status_code": 200
}
Key | Type | Description |
---|---|---|
date |
string | The date when the statistics were collected.
Format: UTC |
organization |
string | The name of the SnapLogic Environment/Org. |
top_tasks |
array | An array of objects containing metadata about the top 10 tasks that consumed API calls. |
task_count |
integer | The number of tasks that were executed in the current day. |
daily_call_used |
integer | The number of pipeline executions that were executed in the current day. |
daily_call_available |
integer | The difference between the daily limit for pipeline executions and the number of pipelines that were already executed during the day. |