643 matches
60 actions
SendGrid
60 actions
Marketing/SendGrid
This endpoint allows you to retrieve stats for a single Automation using its ID.
Multiple Automation IDs can be retrieved using the "Get All Automation Stats" endpoint. Once you have an ID, this endpoint will return detailed stats for the single automation specified.
You may constrain the stats returned using the start_date and end_date query string parameters. You can also use the group_by and aggregated_by query string parameters to further refine the stats returned.
{
"type": "object",
"properties": {
"aggregated_by": {
"type": "string",
"enum": [
"day",
"total"
]
},
"end_date": {
"type": "string",
"format": "date"
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"step_id"
]
}
},
"page_size": {
"type": "integer"
},
"page_token": {
"type": "string"
},
"start_date": {
"type": "string",
"format": "date"
},
"step_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"timezone": {
"type": "string"
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"results"
],
"properties": {
"_metadata": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of items in the entire list, i.e., across all pages."
},
"next": {
"type": "string",
"format": "uri",
"description": "The URL of the next page of results. If this field isn't present, you're at the end of the list."
},
"prev": {
"type": "string",
"format": "uri",
"description": "The URL of the previous page of results. If this field isn't present, you're at the start of the list."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the current page of results."
}
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"aggregation",
"step_id"
],
"properties": {
"aggregation": {
"type": "string",
"description": "This describes the time unit to which the stat is rolled up. It is based on the `aggregated_by` parameter included in the request. It can be \"total\" or the date (in YYYY-MM-DD format) the stats are for."
},
"id": {
"type": "string",
"format": "uuid",
"description": "This is the ID of the Automation you are requesting stats for."
},
"stats": {
"type": "object",
"required": [
"bounce_drops",
"bounces",
"clicks",
"delivered",
"invalid_emails",
"opens",
"requests",
"spam_report_drops",
"spam_reports",
"unique_clicks",
"unique_opens",
"unsubscribes"
],
"properties": {
"bounce_drops": {
"type": "integer"
},
"bounces": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"delivered": {
"type": "integer"
},
"invalid_emails": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"requests": {
"type": "integer"
},
"spam_report_drops": {
"type": "integer"
},
"spam_reports": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"unique_opens": {
"type": "integer"
},
"unsubscribes": {
"type": "integer"
}
}
},
"step_id": {
"type": "string",
"description": "This is the ID of the step if the stats were requested to be grouped by `step_id`."
}
}
}
}
}
}