GoKart - Documentation - Integration
Offer-Centric
Get Offer Details
Endpoint
Parameters
Extra parameters
Field Name
Type
Description
Examples
1
offerId
string/text
A required parameter that specifies the unique ID of the offer to be retrieved.
“3fa85f64-5717-4562-b3fc-2c963f66afa6”
There are no rows in this table
Response
Offer Details schema
API Params Offer Details
Field Name
Type
Description
Examples
1
viewId
string/text
A unique identifier for the View that was created when User viewed Offer Details.
“256d76ef-1d76-4f91-8df5-d48a6cd17f8c”
2
offerData
array
A list of Offer Details described below
3
isUserCompleted
boolean
A flag indicating whether the user has completed the associated event or offer.
true/false
4
userCompletedAt
date (string/text)
null
The date and time when the user completed the event or offer. This field is nullable, meaning it may contain null if the event or offer has not been completed yet.
“2024-10-21T09:26:32.369306+00:00”, null
5
rewardStatus
string/text
null
The status of the reward associated with the event or offer.
"Completed", null
6
sessionId
string/text
A unique identifier for the user's session
7
events
array
A list of events that must be completed within the offer.
[{},{},{}...]
8
id
string/text
A unique identifier for the offer in the form of a UUID.
“3fa85f64-5717-4562-b3fc-2c963f66afa6”
9
name
string/text
The name of the offer, typically used as a title.
“SiriusXM”
10
headline
string/text
A brief, attention-grabbing statement or headline summarizing the offer.
“Get 3 months of streaming for only $1”
11
shortDescription
string/text
A concise description providing key information about the offer.
“Stream sports, music, podcasts and more”
12
keyPoints
string/text
Highlights or main points of the offer.
“Subscribe for 3 month trial for $1 Stream daily for your first 7 days”
13
offerDetails
string/text
A detailed explanation of the offer.
“Download Bingo <br/> Blitz Complete Level "Rome" Collect Coins!”
14
termsAndDisclaimers
string/text
The legal terms, conditions, and disclaimers associated with the offer.
Must make first trade. Award within 30 days
15
creativeFileUrl
string/text
A URL linking to a creative asset associated with the offer, such as an image or video.
https://.../offers/e9e394cb-aa5b-422c-bcd3-17e13247787d/creative.gi
16
categoryName
string/text
The name of the category this offer falls under.
“Fin-Tech”
17
reward
number (floating)
null
The reward amount for completing the offer or specific events.
30, null
18
rewardPendingDays
number (integer)
null
The number of days that the reward will remain in a pending status before it is available to the user.
1, null
19
offerType
enum (string/text)
Can have values: SingleEvent or MultiEvent
“SingleEvent”
There are no rows in this table
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.