643 matches
60 actions
SendGrid
60 actions
Marketing/SendGrid
This endpoint lets you retrieve click-tracking stats for a single Automation.
The stats returned list the URLs embedded in your Automation and the number of clicks each one received.
Responses are paginated. You can limit the number of responses returned per batch using the page_size query string parameter. The default is 50, but you specify a value between 1 and 100.
You can retrieve a specific page of responses with the page_token query string parameter.
{
"type": "object",
"properties": {
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"step_id"
]
}
},
"page_size": {
"type": "integer"
},
"page_token": {
"type": "string"
},
"step_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"_metadata",
"results",
"total_clicks"
],
"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": [
"url",
"step_id",
"clicks"
],
"properties": {
"clicks": {
"type": "integer",
"description": "The number of clicks on this particular link."
},
"step_id": {
"type": "string",
"format": "uuid",
"description": "This is the ID of the step if the stats were requested to be grouped by `step_id`."
},
"url": {
"type": "string",
"format": "uri",
"description": "This is the URL of the link clicked. If `{{custom_fields}}` are part of the URL, they will be included."
},
"url_location": {
"type": "integer",
"description": "This is the location of the link clicked in each Automation step. Links are located according to their position within the message; the topmost link has index `0`."
}
}
}
},
"total_clicks": {
"type": "integer"
}
}
}