Get conversions

HTTP method

Endpoint

GET

/v1/conversion_reports

Path parameters

Parameter

Description

Nullable

start_time

Start time range. Format yyyy-MM-dd HH:mm:ss.

No

end_time

End time range. Format yyyy-MM-dd HH:mm:ss.

No

timezone

Acquire timezone required by the report. Leave this parater vacant, the report will be based on the timezone set by netowrk.

Yes

Note: Test conversion data can be acquired via filter [aff_sub1][EQUAL_TO]=test, and it can be excluded via filter [aff_sub1][NOT_EQUAL_TO]=test

Query string parameters

Conditions

Parameters

Type

Description

Offset

offset

offset

Check page scale.

Limit

limit

limit

The number of date displays in each page. Maximum = 1000

Sort

sort

sort

Ranking according to the specified field ascending "+", or descending "-".

Filters

filters

filter

Query requirements of Specify field.

Support filter conditions

EQUAL_TO NOT_EQUAL_TO LESS_THAN LESS_THAN_OR_EQUAL_TO GREATER_THAN GREATER_THAN_OR_EQUAL_TO CONTAINS NOT_CONTAINS NULL NOT_NULL IN NOT IN

Fields

fields

field

You can choose the field of the query (the result of the query is in line with the selected field).

id

integer

A string that uniquely identifies this conversion report.

conversion_time

integer

Advertiser post back time

click_time

integer

Client-side response time

advertiser_id

integer

The advertiser id.

affiliate_id

integer

The affiliate id.

advertiser_manager_id

integer

The advertiser manager id.

affiliate_manager_id

integer

The affiliate manager id.

offer_id

integer

The offer id.

country

string

Country name; country abbreviation available

source_id

string

Source ID.

click_id

string

Click ID.

click_ip

string

Click IP.

conversion_ip

string

Conversion IP.

user_agent

string

User agent for user when session was started.

status

string

The status of the conversion report. Allowed values: approved·rejected·pending

status_remark

string

The remark providing more granular status details. Allowed values: need_approval offer_redirect duplicate_click offer_expired offer_status_error invalid_security_code ip_not_whitelisted affiliate_status_error affiliate_access_denied affiliate_conversion_cap_exceeded affiliate_payout_cap_exceeded advertiser_conversion_cap_exceeded advertiser_revenue_cap_exceeded conversion_expired conversion_protocol_not_matched encrypt_conversion_enabled event_endpoint_reached event_status_error total_affiliate_conversion_cap_exceeded total_affiliate_payout_cap_exceeded inactive_tracking_domain smartlink_not_found smartlink_status_error smartlink_access_denied

conversion_test

integer

Test Conversion: 0 not test conversion 1 aff_test 2 adv_test Note: better to filter test conversion

referral

string

Conversion Referral URL.

is_post_back

integer

Postback: 0 No; 1 Yes

currency

string

The currency of the offer.

currency_revenue

string

The revenue of the offer.

revenue

double

Offer revenue based on platform default currency

currency_payout

string

The payout of the offer

payout

double

Offer payout based on platform default currency

currency_amount

string

The amount of the offer

amount

double

Offer amount based on platform default currency

profit

string

Offer profit based on platform default currency

ios_idfa

string

iOS IDFA

google_aid

string

Google AID

android_id

string

Android ID.

aff_sub1

string

Affiliate Sub ID 1.

aff_sub2

string

Affiliate Sub ID 2.

aff_sub3

string

Affiliate Sub ID 3.

aff_sub4

string

Affiliate Sub ID 4.

aff_sub5

string

Affiliate Sub ID 5.

adv_sub1

string

Advertiser Sub ID 1.

adv_sub2

string

Advertiser Sub ID 2.

adv_sub3

string

Advertiser Sub ID 3.

platform

string

Click Platform.

Response body parameters

Field

Type

Description

id

integer

The unique id for the report.

conversion_time

integer

Advertiser post back time

click_time

integer

Client-side response time

advertiser_id

integer

The unique id for the advertiser.

affiliate_id

integer

The unique id for the affiliate.

advertiser_manager_id

integer

The unique id for the advertiser manager.

affiliate_manager_id

integer

The unique id for the affiliate manager.

offer_id

integer

The unique id for the offer.

event_id

integer

The offer event id.

is_private_event

integer

private event: 1：Yes；0：No

country

string

Click GEO Country.

state

string

Click GEO State.

city

string

Click GEO City.

source_id

string

Source ID.

click_id

string

Click ID.

click_ip

string

Click IP.

conversion_ip

string

Conversion IP.

user_agent

string

User agent for user when session was started.

status

string

The status of the conversion report. Allowed values: approved·rejected·pending

status_remark

string

The remark providing more granular status details.

conversion_test

integer

Test Conversion: 0 not test conversion 1 aff_test 2 adv_test Note: better to filter test conversion

referral

string

Conversion Referral URL.

is_post_back

integer

Postback: 0 No; 1 Yes

currency

string

The currency of the offer.

currency_revenue

string

The revenue of the offer

revenue

double

Offer revenue based on platform default currency

currency_payout

string

The payout of the offer

payout

double

Offer payout based on platform default currency

currency_amount

string

The amount of the offer

amount

double

Offer amount based on platform default currency

profit

string

Offer profit based on platform default currency

ios_idfa

string

iOS IDFA

google_aid

string

Google AID

android_id

string

Android ID.

aff_sub1

string

Affiliate Sub ID 1.

aff_sub2

string

Affiliate Sub ID 2.

aff_sub3

string

Affiliate Sub ID 3.

aff_sub4

string

Affiliate Sub ID 4.

aff_sub5

string

Affiliate Sub ID 5.

adv_sub1

string

Advertiser Sub ID 1.

adv_sub2

string

Advertiser Sub ID 2.

adv_sub3

string

Advertiser Sub ID 3.

platform

string

Click Platform. Allowed values: PC·Mobile·Tablet

totalPages

integer

The list of data pages (associated with your limit).

totalRows

integer

Total number of available data.

offset

integer

The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.

limit

integer

The number of data displayed on one page

Example request

Request GET https://{networkname}.api.offerslook.com/v1/conversion_reports?end_time=2016-10-22 00:00:00&start_time=2016-09-01 00:00:00&timezone=Asia/Hong_Kong&fields=id,conversion_time,click_id,click_ip,aff_sub1,click_ip,status,offer_id,advertiser_id&sort=+id&offset=2&limit=10&filters[id][GREATER_THAN_OR_EQUAL_TO]=1000&filters[id][LESS_THAN_OR_EQUAL_TO]=5000&filters[aff_sub1][NOT_EQUAL_TO]=test

Request GET http://{networkname}.api.offerslook.com/v1/conversion_reports?end_time=2016-10-22 00:00:00&start_time=2016-09-01 00:00:00&timezone=Asia/Hong_Kong&fields=id,conversion_time,click_id,click_ip,aff_sub1,click_ip,status,offer_id,advertiser_id&sort=+id&offset=2&limit=10filters[id][GREATER_THAN_OR_EQUAL_TO]=1000&filters[id][LESS_THAN_OR_EQUAL_TO]=5000&filters[aff_sub1][NOT_EQUAL_TO]=test

Example response

PreviousConversion ReportsNextApprove conversion by conversion id

Last updated

Was this helpful?