Skip to content
Tallyraydocs

Conversions received from from to to (the last 30 days by default, 13 months at most) by the paths their journeys took: their clicks' connections, or campaigns (by=campaign), in order, the most conversions first; filtered by the conversion's offer, network, event type or coupon, or a campaign or connection it went through

GET
/v1/buyer/reports/paths
curl --request GET \
  --url https://example.com/v1/buyer/reports/paths \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the stats:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
string
to
string
by
string
currency
string
page_size
string
page_token
string
filter
string
exclude
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
as_of
required
string | null format: date-time
currency
required
string
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean
rows
required
Array<object>
object
average_clicks_micros
required
integer format: int64
average_seconds
required
integer format: int64
conversions
required
integer format: int64
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
steps
required
Array<object>
object
clicks
required
integer format: int32
key
required
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
truncated
required
boolean

Example 

{
  "rows": [
    {
      "steps": [
        {
          "key": {
            "dimension": "hour"
          }
        }
      ]
    }
  ]
}

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"
  }
}