GET Offer Details

Name

Type

Description

{product}

string

Defines the tenant's subscripton context. Must be one of: publisher, aff-network, or advertiser.

{id}

string (UUID)

The unique identifier of the offer

Field Name

Type

Description

Example

id

string (UUID)

Unique identifier for the offer.

3fa85f64-5717-4562-b3fc-2c963f66afa6

trackingSystemLink

string

Tracking URL used for the offer redirect.

https://...

trackingSystem

string

Attribution provider used for the offer.

Appsflyer

name

string

Name of the offer (display title).

SiriusXM

headline

string

Short, attention-grabbing summary of the offer.

Get 3 months of streaming for only $1

shortDescription

string

Brief description of the offer.

Stream sports, music, podcasts and more

keyPoints

string

Key highlights of the offer.

Subscribe for 3 month trial for $1

offerDetails

string

Detailed instructions or requirements for completion.

Download Bingo Blitz Complete Level "Rome"

termsAndDisclaimers

string

Terms, conditions, and disclaimers.

Must make first trade. Award within 30 days

offerType

string (enum)

Type of offer (SingleEvent, MultiEvent).

MultiEvent

conversionType

string (enum)

Revenue model (FlatRate, RevShare).

FlatRate

isFeatured

boolean

Indicates whether the offer is featured.

true

dailyCap

number

Maximum number of daily conversions allowed.

100

weeklyCap

number

Maximum number of weekly conversions allowed.

500

monthlyCap

number

Maximum number of monthly conversions allowed.

2000

allTimeCap

number

Maximum total conversions allowed.

10000

dailyConversionCount

number

Number of conversions recorded today.

45

weeklyConversionCount

number

Number of conversions recorded this week.

210

monthlyConversionCount

number

Number of conversions recorded this month.

800

allTimeConversionCount

number

Total number of conversions recorded.

5000

advertiserCampaignName

string

Name of the campaign provided by the advertiser

Campaign_test_ios

shouldSendCostData

boolean

Indicates if cost data should be sent to Singular/Appsflyer

true

allowRepetitions

boolean

Indicates if the offer can be completed multiple times.

false

budgetType

string

Type of budget applied to the offer.

Daily

budgetAmount

number

Budget allocated to the offer.

1000

launchDate

string (ISO 8601)

Date the offer was launched.

2025-02-27T23:00:00Z

endDate

string (ISO 8601)

Date the offer expires.

2025-02-27T23:00:00Z

showAtBottomToAllUnselectedGenders

boolean

Controls fallback behavior for gender targeting.

false

deviceTypes

string | array

Supported device types.

iOS, Android

revenue

number

Revenue generated per conversion.

30

reward

number

Reward amount given to the user.

10

rewardingType

string

Defines how rewards are issued.

Automatic

pendingTime

number

Number of days the conversion status remains Pending

10

baselineEpc

string (enum)

The EPC value the offer is assigned when first launched until the true EPC can be determined

5

lockBaselineEpc

boolean

Indicates if EPC is locked.

false

ageId

string (UUID)

Age targeting identifier.

uuid

categoryIds

array (UUID)

List of category IDs.

[uuid1, uuid2]

countryIds

array (UUID)

List of targeted countries.

[US, CA]

countryStateIds

array (UUID)

List of targeted states/regions.

[CA-ON]

zipCodes

array (string)

List of targeted ZIP/postal codes.

[92801, 90001]

genderIds

array (UUID)

List of targeted genders.

[male, female]

placementIds

array (UUID)

List of placement identifiers.

[uuid1, uuid2]

advertiserId

string (UUID)

Unique identifier for the advertiser.

3fa85f64-5717-4562-b3fc-2c963f66afa6

offerCostReportInfo

array

Additional cost/reporting info for the advertiser.

[{...}]

offerCostReportInfo.costType

string

Type of cost model used for reporting. Supported values: CPI, CPA

CPI

offerCostReportInfo.appName

string

Name of the app associated with the offer.

Coin Game

offerCostReportInfo.storeId

string

App store identifier (e.g., App Store ID or Google Play package name).

com.example.app

offerEvents

array

List of event objects for multi-event offers.

[{...}]

offerEvents.id

string (UUID)

Unique identifier for the event.

e9623b92-4d90-404d-beaf-6b27a7ac66ac

offerEvents.name

string

Name of the event.

Install

offerEvents.showOnOfferWall

boolean

Indicates if the event is visible on the offer wall.

true

offerEvents.eventId

string

External identifier for the event.

Level 1

offerEvents.displayOrder

number

Display order of the event.

2

offerEvents.sequenceNumber

number | null

Sequence order of the event; null if independent.

3

offerEvents.minTimeFromPreviousEvent

number | null

Minimum time required after previous event

24

offerEvents.deadlineDays

number | null

Days allowed to complete the event.

30

offerEvents.pendingTime

number | null

Number of days the conversion status remains Pending

30

offerEvents.hasRevenue

boolean

Indicates if the event has revenue.

true

offerEvents.revenue

number | null

Revenue for the event.

5

offerEvents.hasReward

boolean

Indicates if the event has a reward.

true

offerEvents.useDefaultRatio

boolean

Uses default reward/revenue ratio.

true

offerEvents.reward

number | null

Reward amount for the event.

2

offerEvents.dailyCap

number | null

Daily cap for the event.

100

offerEvents.weeklyCap

number | null

Weekly cap for the event.

500

offerEvents.monthlyCap

number | null

Monthly cap for the event.

2000

offerEvents.allTimeCap

number | null

Total cap for the event.

10000

offerEvents.dailyConversionCount

number

Daily conversions for the event.

20

offerEvents.weeklyConversionCount

number

Weekly conversions for the event.

80

offerEvents.monthlyConversionCount

number

Monthly conversions for the event.

300

offerEvents.allTimeConversionCount

number

Total conversions for the event.

2000

offerEvents.allowRepetitions

boolean

Indicates if the event can be repeated.

false

creatives

array

List of creative assets.

[{...}]

creatives.order

integer

Position index of the creative.

1

creatives.url

string

URL of the creative asset.

https://example.com/image.png

creatives.metadata

string | null

Optional metadata for the creative.

banner

isPaused

boolean

Indicates if the offer is paused.

false

status

string

Current status of the offer.

Active