Affiliates

Affiliate

One affiliate partner by id or referral code, with codes and its clicks and conversions (all time, or in the window passed).

get/affiliates/{affiliate_id}

Request

  • Base URL: https://api.onelence.com/v1
  • URL: https://api.onelence.com/v1/affiliates/{affiliate_id}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.onelence.com/oauth/authorize, token URL https://api.onelence.com/oauth/token, scopes: analytics:read)
    • HTTP bearer

Path parameters

affiliate_idstring required

The partner id from the affiliates list, or its referral code.

Query parameters

startstring

Count clicks and conversions from this date (YYYY-MM-DD) or ISO 8601 date-time. Without start, there is no lower bound; without either, all time.

endstring

Count up to this date (inclusive) or ISO 8601 date-time. Without end, there is no upper bound.

compare'none' | 'previous_period'

previous_period adds each partner's clicks and conversions in the same-length window right before start, with the percent change (default none). Needs start.

Response

Success.

object'affiliate' required
idstring required
namestring required
statusstring required
site_idstring nullable required
codestring nullable required
coupon_codesstring[] required
metrics_state'available' | 'unavailable' required
clicksnumber nullable required
conversionsnumber nullable required
conversion_rate_pctnumber nullable required
created_atstring nullable required
previous_clicksnumber nullable
clicks_change_pctnumber nullable
previous_conversionsnumber nullable
conversions_change_pctnumber nullable

Changes

No recorded changes to this operation across all 1 revision of this API.