Skip to main content
GET
Retrieve a conversion value rule

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-15"

Path Parameters

id
string
required

Conversion value rule ID.

Response

200 - application/json

Rule

account_id
string
required

Business that owns this shared, editable rule.

Example:

"biz_xxxxxxxxxxxxxx"

adjustment_type
enum<string>
required

Set a fixed amount or change the original value by a signed percentage.

Available options:
fixed,
percentage
Example:

"fixed"

created_at
string
required

When the rule was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

events
object[]
required
fixed_value
object | null
required

Amount sent for a fixed rule. Null for a percentage rule.

id
string
required

Conversion value rule ID, prefixed adcvr_.

Example:

"adcvr_xxxxxxxxxxxxxx"

metadata
object
required

Free-form string keys and values for the caller.

Example:
percentage_change
number | null
required

Signed percent change: 20 increases by 20%, negative 20 decreases by 20%. The sent value cannot go below zero. Null for a fixed rule.

status
enum<string>
required

Whether this rule is active or paused.

Available options:
active,
paused
Example:

"active"

targets
object[]
required
updated_at
string
required

When the rule was edited, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"