Uptick

data.attributes.offers

hash

required

Where you should show a count of offers

Must be a Hash

data.attributes.header

array

required

The header of the offer

Must be an Array of nested elements

data.attributes.header.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.header.text

string

required

The text of the segment

Must be a String

data.attributes.header.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.header.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.header.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.header.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.header.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.header.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.header.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.header.children

array

required

The children of the segment

Must be an Array of nested elements

data.attributes.header.children.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.header.children.text

string

required

The text of the segment

Must be a String

data.attributes.header.children.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.header.children.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.header.children.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.header.children.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.header.children.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.header.children.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.header.children.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.image

hash

required

The image of the offer

Must be a Hash

data.attributes.personalization

array

required

The personalization of the offer

Must be an Array of nested elements

data.attributes.personalization.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.personalization.text

string

required

The text of the segment

Must be a String

data.attributes.personalization.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.personalization.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.personalization.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.personalization.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.personalization.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.personalization.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.personalization.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.personalization.children

array

required

The children of the segment

Must be an Array of nested elements

data.attributes.personalization.children.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.personalization.children.text

string

required

The text of the segment

Must be a String

data.attributes.personalization.children.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.personalization.children.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.personalization.children.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.personalization.children.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.personalization.children.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.personalization.children.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.personalization.children.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.content

array

required

The content of the offer

Must be an Array of nested elements

data.attributes.content.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.content.text

string

required

The text of the segment

Must be a String

data.attributes.content.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.content.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.content.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.content.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.content.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.content.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.content.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.content.children

array

required

The children of the segment

Must be an Array of nested elements

data.attributes.content.children.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.content.children.text

string

required

The text of the segment

Must be a String

data.attributes.content.children.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.content.children.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.content.children.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.content.children.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.content.children.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.content.children.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.content.children.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.disclaimer

array

required

The disclaimer of the offer

Must be an Array of nested elements

data.attributes.disclaimer.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.disclaimer.text

string

required

The text of the segment

Must be a String

data.attributes.disclaimer.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.disclaimer.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.disclaimer.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.disclaimer.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.disclaimer.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.disclaimer.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.disclaimer.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.disclaimer.children

array

required

The children of the segment

Must be an Array of nested elements

data.attributes.disclaimer.children.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.disclaimer.children.text

string

required

The text of the segment

Must be a String

data.attributes.disclaimer.children.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.disclaimer.children.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.disclaimer.children.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.disclaimer.children.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.disclaimer.children.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.disclaimer.children.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.disclaimer.children.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.disclaimer_color

string

required

The color of the disclaimer for the offer

Must be a String

data.attributes.sponsored

array

required

The sponsor of the offer

Must be an Array of nested elements

data.attributes.sponsored.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.sponsored.text

string

required

The text of the segment

Must be a String

data.attributes.sponsored.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.sponsored.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.sponsored.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.sponsored.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.sponsored.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.sponsored.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.sponsored.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.sponsored.children

array

required

The children of the segment

Must be an Array of nested elements

data.attributes.sponsored.children.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.sponsored.children.text

string

required

The text of the segment

Must be a String

data.attributes.sponsored.children.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.sponsored.children.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.sponsored.children.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.sponsored.children.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.sponsored.children.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.sponsored.children.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.sponsored.children.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.actions

array

required

The actions of the offer

Must be an Array of nested elements

data.attributes.actions.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.actions.text

string

required

The text of the segment

Must be a String

data.attributes.actions.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.actions.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.actions.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.actions.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.actions.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.actions.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.actions.attributes.to

string

required

The URL to use for the link

Must be a String

data.attributes.actions.children

array

required

The children of the segment

Must be an Array of nested elements

data.attributes.actions.children.type

string

required

What type of segment this is

Must be one of: text, newline, button, spacer.

data.attributes.actions.children.text

string

required

The text of the segment

Must be a String

data.attributes.actions.children.attributes

hash

required

The attributes of the segment

Must be a Hash

data.attributes.actions.children.attributes.spacing

string

required

The margin of the segment

Must be one of: tight.

data.attributes.actions.children.attributes.kind

string

required

The kind of button to render

Must be one of: secondary.

data.attributes.actions.children.attributes.size

string

required

The font size of the segment

Must be one of: large.

data.attributes.actions.children.attributes.appearance

string

required

The appearance of the segment

Must be one of: accent, monochrome.

data.attributes.actions.children.attributes.emphasis

string

required

The emphasis of the segment

Must be one of: bold, italic, del.

data.attributes.actions.children.attributes.to

string

required

The URL to use for the link

Must be a String

Events

Flows

Offers

Supported Formats

Path Parameters

Returns

Response - Offer viewed