Skip to content
Tallyraydocs

A link's report: its rows in its columns, totals, chart and as_of, paged by page_size (up to 500) and page_token. Every link that doesn't open answers 404 link_not_found

GET
/v1/shared/reports/{token}
curl --request GET \
  --url https://example.com/v1/shared/reports/example

Who: anyone.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
string

Query Parameters

Section titled “Query Parameters”
page_size
string
page_token
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
as_of
required
string | null format: date-time
columns
required
Array<string | null>
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
compared
required
Any of:
object
from
required
string format: date-time
to
required
string format: date-time
comparison_series
required
Array<object>
object
bot_impressions
required
integer format: int64
bot_share_ppm
required
integer format: int64
bots
required
integer format: int64
by_model
required
Array<object>
object
conversions_micros
required
integer format: int64
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
changes
required
Array<object>
object
absolute
required
integer format: int64
absolute_micros
required
integer | null format: int64
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
relative_ppm
required
integer | null format: int64
clicks
required
integer format: int64
comparison
required
Any of:
object recursive
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
cost
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpm
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cr_ppm
required
integer format: int64
ctr_ppm
required
integer format: int64
epc
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
epv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
event_types
required
Array<object>
object
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
event_type
required
string
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
ictr_ppm
required
integer format: int64
impressions
required
integer | null format: int64
keys
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
id
required
integer format: int64
name
required
string
period_end
required
string | null format: date-time
period_start
required
string | null format: date-time
value
required
string
pending_revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
unique_visits
required
integer format: int64
visits
required
integer format: int64
currency
required
string
expires_at
required
string format: date-time
filters
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
exclude
required
boolean
values
required
Array<string>
from
required
string format: date-time
group_by
required
Array<string | null>
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
interval
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
kind
required
string | null
Allowed values: live snapshot
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
name
required
string
rows
required
Array<object>
object
bot_impressions
required
integer format: int64
bot_share_ppm
required
integer format: int64
bots
required
integer format: int64
by_model
required
Array<object>
object
conversions_micros
required
integer format: int64
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
changes
required
Array<object>
object
absolute
required
integer format: int64
absolute_micros
required
integer | null format: int64
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
relative_ppm
required
integer | null format: int64
clicks
required
integer format: int64
comparison
required
Any of:
object recursive
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
cost
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpm
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cr_ppm
required
integer format: int64
ctr_ppm
required
integer format: int64
epc
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
epv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
event_types
required
Array<object>
object
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
event_type
required
string
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
ictr_ppm
required
integer format: int64
impressions
required
integer | null format: int64
keys
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
id
required
integer format: int64
name
required
string
period_end
required
string | null format: date-time
period_start
required
string | null format: date-time
value
required
string
pending_revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
unique_visits
required
integer format: int64
visits
required
integer format: int64
series
required
Array<object>
object
bot_impressions
required
integer format: int64
bot_share_ppm
required
integer format: int64
bots
required
integer format: int64
by_model
required
Array<object>
object
conversions_micros
required
integer format: int64
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
changes
required
Array<object>
object
absolute
required
integer format: int64
absolute_micros
required
integer | null format: int64
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
relative_ppm
required
integer | null format: int64
clicks
required
integer format: int64
comparison
required
Any of:
object recursive
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
cost
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpm
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cr_ppm
required
integer format: int64
ctr_ppm
required
integer format: int64
epc
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
epv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
event_types
required
Array<object>
object
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
event_type
required
string
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
ictr_ppm
required
integer format: int64
impressions
required
integer | null format: int64
keys
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
id
required
integer format: int64
name
required
string
period_end
required
string | null format: date-time
period_start
required
string | null format: date-time
value
required
string
pending_revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
unique_visits
required
integer format: int64
visits
required
integer format: int64
slot_labels
required
Array<object>
object
connection_id
required
integer format: int64
label
required
string
param
required
string
slot
required
integer format: int32
sort
required
Array<string>
taken_at
required
string | null format: date-time
time_basis
required
string | null
Allowed values: visit conversion
time_zone
required
string
to
required
string format: date-time
totals
required
object
bot_impressions
required
integer format: int64
bot_share_ppm
required
integer format: int64
bots
required
integer format: int64
by_model
required
Array<object>
object
conversions_micros
required
integer format: int64
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
changes
required
Array<object>
object
absolute
required
integer format: int64
absolute_micros
required
integer | null format: int64
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
relative_ppm
required
integer | null format: int64
clicks
required
integer format: int64
comparison
required
Any of:
object recursive
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
cost
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpm
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cr_ppm
required
integer format: int64
ctr_ppm
required
integer format: int64
epc
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
epv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
event_types
required
Array<object>
object
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
event_type
required
string
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
ictr_ppm
required
integer format: int64
impressions
required
integer | null format: int64
keys
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
id
required
integer format: int64
name
required
string
period_end
required
string | null format: date-time
period_start
required
string | null format: date-time
value
required
string
pending_revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
unique_visits
required
integer format: int64
visits
required
integer format: int64
trends
required
Array<object>
object
kind
required
string | null
Allowed values: moving_average linear
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
points
required
Array<integer | null>
slope_micros
required
integer | null format: int64
window
required
integer format: int32
truncated
required
boolean

Example 

{
  "columns": [
    "visits"
  ],
  "comparison_series": [
    {
      "by_model": [
        {
          "model": "last_click"
        }
      ],
      "changes": [
        {
          "measure": "visits"
        }
      ],
      "keys": [
        {
          "dimension": "hour"
        }
      ]
    }
  ],
  "filters": [
    {
      "dimension": "hour"
    }
  ],
  "group_by": [
    "hour"
  ],
  "interval": "hour",
  "kind": "live",
  "model": "last_click",
  "rows": [
    {
      "by_model": [
        {
          "model": "last_click"
        }
      ],
      "changes": [
        {
          "measure": "visits"
        }
      ],
      "keys": [
        {
          "dimension": "hour"
        }
      ]
    }
  ],
  "series": [
    {
      "by_model": [
        {
          "model": "last_click"
        }
      ],
      "changes": [
        {
          "measure": "visits"
        }
      ],
      "keys": [
        {
          "dimension": "hour"
        }
      ]
    }
  ],
  "time_basis": "visit",
  "totals": {
    "by_model": [
      {
        "model": "last_click"
      }
    ],
    "changes": [
      {
        "measure": "visits"
      }
    ],
    "keys": [
      {
        "dimension": "hour"
      }
    ]
  },
  "trends": [
    {
      "kind": "moving_average",
      "measure": "visits"
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}