Conversion Data API

Endpoint URL

HTTP method

GET

Refresh rate

5 minutes

Query parameter

Data type

Required

Description

from_date

string

no

Start date of the reporting period, formatted as YYYY-MM-DD. If not provided, the default range is the previous 7 days.

to_date

string

no

End date of the reporting period, formatted as YYYY-MM-DD. If not provided, the default range is the previous 7 days.

user_id

string

no

Filter results by user ID.

offer_id

string

no

Filter results by offer ID.

is_reverse

boolean

no

Filter results by reversal status. Set to true to return only reversed events.

per_page

number

no

Number of records to return per page.

page

number

no

Page number to return. Used for paginated results.

type

string

no

Filter results by conversion type. Possible values are offer or survey.

Attributes

Data Type

Description

Example

Data

user_id

string

The user's unique ID in your system. IDs are case-insensitive and limited to 50 characters.

"asdfn-234ghhh"

transaction_id

number

Unique ID for the conversion traction. Use this value for deduplication. If a reversal occurs, the same transaction ID will be sent again with reverse=1.

45415

reward

number

Reward amount awarded to the user, in USD.

40

reward_local_currency

number

Reward amount awarded to the user in your local currency (for example, points or coins). Calculated using your configured currency-to-USD conversion ratio.

4000

payout

number

Amount paid to you (the partner), in USD. Corresponds to the cpi value returned in the Games and Games User Data APIs, or the cpa value returned in the Deals and Deals User Data APIs.

3.25

offer_id

string

Unique identifier for the offer.

"dgh471b5kgcn or tv1657278769"

offer_name

string

Name of the offer the user is participating in.

"Coin Master or Family Island"

note

string

A description of the completed goal or conversion event.

"Level 91 Reached"

date_time

string/datetime

Date and time the event occured, in EST.

"2024-12-04 06:25:36"

goal_id

string

Unique identifier for the goal within the offer.

"tU5z8PU5BIR9_133"

reverse

boolean

Indicates that a previously reported conversion has been reversed. When present with a value of 1, the amounts in reward and reward_local_currency should be deducted. Reversals typically occur when a user is later determined to be ineligible for an offer.

1

type*

string

Conversion type. Returned only when surveys are enabled. Possible values are offer or survey.

"survey"

survey_id*

string

Unique identifier for the survey. Returned only for survey conversions.

"1b45c7"

Links

first

string

URL for the first page of results.

"https://wall.besitos.ai/data/partner/conversions?page=1"

last

string

URL for the last page of results.

"https://wall.besitos.ai/data/partner/conversions?page=13"

prev

string

URL for the previous page. Returns null if no previous page exists.

"https://wall.besitos.ai/data/partner/offers/YB3hWcZ2/kyc?page=10"

next

string

URL for the next page. Returns null if no next page exists.

"https://wall.besitos.ai/data/partner/offers/YB3hWcZ2/kyc?page=11"

Meta

current_page

number

Current page number.

1

from

number

Index of the first item returned on the current page.

1

to

number

Index of the last item returned on the current page.

5

last_page

number

The total number of pages available.

4

links

array

Pagination link objects containing url, label, and active attributes. Returns an empty array if no links are available.

includes “url”, “label” and “active” attributes

path

string

Base URL used for pagination.

"https://wall.besitos.ai/data/partner/conversions"

per_page

number

Maximum number of items returned per page.

1000

total

number

Total number of items available across all pages.

6