Skip to content
Tallyraydocs

Change a view's name, visibility or query: its owner's, or any for the workspace's owner. Its links and schedules keep their copies until shared or updated again

PATCH
/v1/buyer/reports/views/{id}
curl --request PATCH \
  --url https://example.com/v1/buyer/reports/views/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_sequence": 1, "name": "example", "query": { "columns": [ "visits" ], "compare": { "dates": { "from": "example", "to": "example" }, "preset": "previous_period" }, "currency": "example", "filter_labels": [ { "dimension": "hour", "label": "example", "value": "example" } ], "filters": [ { "dimension": "hour", "exclude": true, "values": [ "example" ] } ], "group_by": [ "hour" ], "model": "last_click", "range": { "dates": { "from": "example", "to": "example" }, "preset": "today" }, "sort": [ "example" ], "time_basis": "visit", "time_zone": "example", "trends": [ { "kind": "moving_average", "measure": "visits", "window": 1 } ] }, "visibility": "private" }'

Who: a workspace’s buyer or viewer. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
expected_sequence
integer format: int64
name
string | null
query
Any of:
object
columns
Array<string>
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
compare
Any of:
object
dates
Any of:
object
from
required
string
to
required
string
preset
string
Allowed values: previous_period
currency
string
filter_labels
Array<object>
object
dimension
required
string
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
label
required
string
value
required
string
filters
Array<object>
object
dimension
required
string
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
boolean
values
required
Array<string>
group_by
Array<string>
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
model
string
Allowed values: last_click first_click linear time_decay position_based
range
required
object
dates
Any of:
object
from
required
string
to
required
string
preset
string
Allowed values: today yesterday last_7_days last_30_days last_90_days month_to_date last_month
sort
Array<string>
time_basis
string
Allowed values: visit conversion
time_zone
string
trends
Array<object>
object
kind
required
string
Allowed values: moving_average linear
measure
required
string
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
window
integer format: int32
visibility
string | null
Allowed values: private shared

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
id
required
integer format: int64
links
required
integer format: int32
name
required
string
owner
required
Any of:
object
id
required
string
name
string
query
required
object
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
compare
required
Any of:
object
dates
required
Any of:
object
from
required
string
to
required
string
preset
required
string | null
Allowed values: previous_period
currency
required
string
filter_labels
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
label
required
string
value
required
string
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>
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
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
range
required
object
dates
required
Any of:
object
from
required
string
to
required
string
preset
required
string | null
Allowed values: today yesterday last_7_days last_30_days last_90_days month_to_date last_month
sort
required
Array<string>
time_basis
required
string | null
Allowed values: visit conversion
time_zone
required
string
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
window
required
integer format: int32
schedules
required
integer format: int32
sequence
required
integer format: int64
updated_at
required
string format: date-time
updated_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
visibility
required
string | null
Allowed values: private shared
workspace_id
required
integer format: int64

Example 

{
  "created_by": {
    "kind": "user"
  },
  "query": {
    "columns": [
      "visits"
    ],
    "compare": {
      "preset": "previous_period"
    },
    "filter_labels": [
      {
        "dimension": "hour"
      }
    ],
    "filters": [
      {
        "dimension": "hour"
      }
    ],
    "group_by": [
      "hour"
    ],
    "model": "last_click",
    "range": {
      "preset": "today"
    },
    "time_basis": "visit",
    "trends": [
      {
        "kind": "moving_average",
        "measure": "visits"
      }
    ]
  },
  "updated_by": {
    "kind": "user"
  },
  "visibility": "private"
}

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