GoKart - Documentation - Offer Wall Integration
PubMember-Centric
Get Offers
Note: For details on how to handle new fields in our API schema, please see our
Endpoint
api/v1/offer-wall/pub-member/offers
Parameters
PubMember Offers Parameters
Field Name
Type
Description
Examples
pub_member_id
string/text
ID of a publisher's member
“123”
filter.Progress
enum (string)
Filtering for Status of offer (In Progress, Completed)
“In Progress”
There are no rows in this table
Endpoints supports pagination, filtering and sorting parameters, more details below.
Note: by default this endpoint uses sorting by our EPC algorithm
Response
it returns the general response schema, more details below
And it contains general pagination schema, more details below
PubMember Offers schema
API Params PubMember Offers
Field Name
Type
Description
Examples
isUserCompleted
boolean
A flag indicating whether the user has completed the associated event or offer.
true/false
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
rewardStatus
string/text
null
The status of the reward associated with the event or offer.
"Completed", null
sessionId
string/text
A unique identifier for the user's session
events
array
A list of events that must be completed within the offer.
[{},{},{}...]
id
string/text
A unique identifier for the offer in the form of a UUID.
“3fa85f64-5717-4562-b3fc-2c963f66afa6”
name
string/text
The name of the offer, typically used as a title.
“SiriusXM”
headline
string/text
A brief, attention-grabbing statement or headline summarizing the offer.
“Get 3 months of streaming for only $1”
shortDescription
string/text
A concise description providing key information about the offer.
“Stream sports, music, podcasts and more”
keyPoints
string/text
Highlights or main points of the offer.
“Subscribe for 3 month trial for $1 Stream daily for your first 7 days”
offerDetails
string/text
A detailed explanation of the offer.
“Download Bingo <br/> Blitz Complete Level "Rome" Collect Coins!”
termsAndDisclaimers
string/text
The legal terms, conditions, and disclaimers associated with the offer.
Must make first trade. Award within 30 days
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
categoryName
string/text
The name of the category this offer falls under.
“Fin-Tech”
reward
number (floating)
null
The reward amount for completing the offer or specific events.
30, null
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
offerType
enum (string/text)
Can have values: SingleEvent or MultiEvent
“SingleEvent”
There are no rows in this table
Request:
GET https://api.brownboots.getgokart.ai/api/v1/offer-wall/pub-member/offers?pub_member_id=123&filter.Progress=InProgress
Response:
{
"data": {
"offers": {
"indexFrom": 0,
"pageIndex": 0,
"pageSize": 10,
"totalCount": 12,
"totalPages": 2,
"items": [
{
"isUserCompleted": true,
"userCompletedAt": "2024-10-21T09:26:32.369306+00:00",
"rewardStatus": "Completed",
"sessionId": null,
"events": [],
"id": "6ba57ffe-3eda-404c-9c7c-1bd466a18886",
"name": "Credit Strong",
"headline": "Start your credit repair today!",
"shortDescription": "Sign up and earn 5000 coins today!",
"keyPoints": "<ul>\n<li>Create an account</li>\n<li>Sign up for a membership</li>\n<li>Collect your coins!</li>\n</ul>\n",
"offerDetails": "<p></p>\n",
"termsAndDisclaimers": "<p>CreditStrong is a division of Austin Capital Bank, an independent community bank and member of the FDIC. CreditStrong is a fintech product in and around the credit building space.</p>\n",
"creativeFileUrl": "https://gokartstorage.blob.core.windows.net/tenants/brightwheels/offers/6ba57ffe-3eda-404c-9c7c-1bd466a18886/creative.png",
"categoryName": "News",
"reward": 5000,
"rewardPendingDays": 1,
"offerType": "SingleEvent"
},
...
],
"hasPreviousPage": false,
"hasNextPage": true
}
},
"responseId": "442c1dfd-9039-4b1a-b94d-082c2db39ecd",
"isSuccessful": true,
"responseTitle": "Success",
"responseType": "Success",
"messages": []
}
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.