Skip to content

Get line item reporting metrics

POST
/reporting/line-items
curl --request POST \
--url https://gateway.staging.arago-tech.com/reporting/line-items \
--header 'Content-Type: application/json' \
--data '{ "line_item_ids": [ "63e2d42a27ad5f2b345ca123", "63e2d42a27ad5f2b345ca124" ], "key_performance_indicators": [ "KEY_PERFORMANCE_INDICATOR_IMPRESSION", "KEY_PERFORMANCE_INDICATOR_CLICK" ], "sort": { "desc": true, "field": "impression" }, "date_range": { "from": "2021-01-01T00:00:00Z", "to": "2021-01-31T00:00:00Z" } }'

Returns aggregated performance metrics for specific line items

Returns aggregated line item metrics grouped by line item, creative, and resolution

Media typeapplication/json
Get report at line item level

Returns aggregated line item metrics grouped by line item, creative, and resolution

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"
]
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"
]
sort
Sort

Optional sort parameters for ordering the results. Can be “line_item_id”, “creative_id”, “resolution”, “impression”, “click”, “viewability_measurable”, “viewable_mrc_50”, “spend”, “cost_per_mille”, “viewable_cost_per_mille”, “measurement_rate”, “view_through_rate”, “click_through_rate”.

object
field
Field

The field to sort by. This should be a valid field name in the context of the request.

string
desc
Desc

The sort order. If true, the results will be sorted in descending order. If false, the results will be sorted in ascending order.

boolean
Example
{
"desc": true,
"field": "impression"
}
date_range
Date Range

Optional date range filter. When omitted, all-time metrics 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"
}

A successful response.

Media typeapplication/json
Get report at line item level response

The response containing the aggregated line item metrics

object
aggregated_metrics
Array<object>
object
line_item_id
string
creative_id
string
resolution
string
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
{
"aggregated_metrics": [
{
"line_item_id": "example",
"creative_id": "example",
"resolution": "example",
"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": "PATTERN",
"field": "username",
"message": "does not match regex pattern `^[a-zA-Z]*$`"
},
{
"code": "MIN_LEN",
"field": "username",
"message": "must be at least 3 characters",
"params": {
"min": "3"
}
}
],
"message": "Bad request"
}
}

Unauthorized

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

Forbidden

Media typeapplication/json
object
Example
{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
}
}

Not found

Media typeapplication/json
object
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL",
"details": [
{
"code": "INTERNAL",
"field": "line_items[0]",
"message": "Couldn't upsert line item"
},
{
"code": "INTERNAL",
"field": "line_items[380]",
"message": "Couldn't upsert line item"
}
],
"message": "Internal server error"
}
}

Gateway timeout

Media typeapplication/json
object
Example
{
"error": {
"code": "TIMEOUT",
"details": [
{
"code": "TIMEOUT",
"field": "request",
"message": "Request processing time exceeded deadline",
"params": {
"duration": "30s"
}
}
],
"message": "Gateway timeout"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field.

Protobuf APIs provide utilities to interact with Any values:

  • A ‘pack’ operation accepts a message and constructs a generic Any wrapper around it.
  • An ‘unpack’ operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url.
  • An ‘is’ operation decides whether an Any contains a message of the given type, i.e. whether it can ‘unpack’ that type.

The JSON format representation of an Any follows one of these cases:

  • For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL.
  • For types with special-cased JSON encodings (typically called ‘well-known’ types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value.

The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.

object
@type

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}