Skip to content

Get campaign reporting metrics

GET
/reporting/campaigns/{id}
curl --request GET \
--url https://portal.staging.arago-tech.com/reporting/campaigns/example \
--header 'Authorization: <Authorization>'

Returns aggregated performance metrics for a campaign

id
required
string

The unique identifier of the campaign in hexadecimal format

date_range.from
string format: date-time

From Date

Filter items with date on or after this timestamp

date_range.to
string format: date-time

To Date

Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.

A successful response.

Media typeapplication/json
object
impression
string format: uint64
click
string format: uint64
viewability_measurable
string format: uint64
viewable_mrc_50
string format: uint64
spend
number format: double
cost_per_mille
number format: double
viewable_cost_per_mille
number format: double
measurement_rate
number format: double
view_through_rate
number format: double
click_through_rate
number format: double
Examplegenerated
{
"impression": "example",
"click": "example",
"viewability_measurable": "example",
"viewable_mrc_50": "example",
"spend": 1,
"cost_per_mille": 1,
"viewable_cost_per_mille": 1,
"measurement_rate": 1,
"view_through_rate": 1,
"click_through_rate": 1
}

Bad request

Media typeapplication/json
object
Example
{
"error": {
"code": "BAD_REQUEST",
"details": [
{
"code": "MAX_ITEMS",
"field": "line_items",
"message": "value must contain no more than 3000 item(s)",
"params": {
"max": "3000"
}
}
],
"message": "Bad request"
}
}

Unauthorized

Media typeapplication/json
object
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}