Skip to content

Get line items reporting metrics series

POST
/reporting/line-items/series
curl --request POST \
--url https://portal.staging.arago-tech.com/reporting/line-items/series \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "line_item_ids": [ "63e2d42a27ad5f2b345ca123", "63e2d42a27ad5f2b345ca124" ], "granularity": "GRANULARITY_UNSPECIFIED", "date_range": { "from": "2021-01-01T00:00:00Z", "to": "2021-01-31T00:00:00Z" }, "key_performance_indicators": [ "KEY_PERFORMANCE_INDICATOR_IMPRESSION", "KEY_PERFORMANCE_INDICATOR_CLICK" ] }'

Returns performance metrics series over time for specific line items

Returns performance metrics series over time for specific line items

Media typeapplication/json
Get report series at line item level

Returns performance metrics series over time for specific line items

object
line_item_ids
required
Line Item IDs

The unique identifiers of the line items to get metrics from

Array<string>
>= 1 items <= 50 items
Example
[
"63e2d42a27ad5f2b345ca123",
"63e2d42a27ad5f2b345ca124"
]
granularity
required
Granularity

The granularity of the time buckets (hour or day)

string
default: GRANULARITY_UNSPECIFIED
Allowed values: GRANULARITY_UNSPECIFIED GRANULARITY_HOUR GRANULARITY_DAY
Example
GRANULARITY_HOUR
date_range
Date Range

Optional date range filter for the metrics series. When omitted, all-time metrics series are returned.

object
from
From Date

Filter items with date on or after this timestamp

string format: date-time
Example
2024-01-01T00:00:00Z
to
To Date

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

string format: date-time
Example
2025-01-01T00:00:00Z
Example
{
"from": "2021-01-01T00:00:00Z",
"to": "2021-01-31T00:00:00Z"
}
key_performance_indicators
Key Performance Indicators

Optional key performance indicators that will be returned in the metrics series. When omitted, all key performance indicators are returned.

Array<string>
Allowed values: KEY_PERFORMANCE_INDICATOR_UNSPECIFIED KEY_PERFORMANCE_INDICATOR_IMPRESSION KEY_PERFORMANCE_INDICATOR_CLICK KEY_PERFORMANCE_INDICATOR_VIEWABILITY_MEASURABLE KEY_PERFORMANCE_INDICATOR_VIEWABLE_MRC_50 KEY_PERFORMANCE_INDICATOR_SPEND KEY_PERFORMANCE_INDICATOR_COST_PER_MILLE KEY_PERFORMANCE_INDICATOR_VIEWABLE_COST_PER_MILLE KEY_PERFORMANCE_INDICATOR_MEASUREMENT_RATE KEY_PERFORMANCE_INDICATOR_VIEW_THROUGH_RATE KEY_PERFORMANCE_INDICATOR_CLICK_THROUGH_RATE
Example
[
"KEY_PERFORMANCE_INDICATOR_IMPRESSION",
"KEY_PERFORMANCE_INDICATOR_CLICK"
]

A successful response.

Media typeapplication/json
object
series
Array<object>
object
line_item_id
string
points
Array<object>
object
timestamp
string format: date-time
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
{
"series": [
{
"line_item_id": "example",
"points": [
{
"timestamp": "2026-04-15T12:00:00Z",
"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"
}
]
}