search

▪️Reporting API

circle-info

This document describes API to get affiliation metrics (commission, balance, registrations, etc.).

It can be used by the Operator - to get metrics for all affiliates

Or it can be used by the Affiliate - to get only their own metrics

triangle-exclamation

The default API URL is https://boapi.smartico.ai/ but depending on your setup it could be different. Check for the exact URL in the 'Settings' section. If you are an affiliate, check for the exact URL in 'Account Settings' section in your profile.

TheAffiliatePlatform (TAP) provides API to retrieve configurational, operational, and analytical data. API is provided as a REST over HTTP and uses SSL for data protection.

Reporting API is designed for the high level aggregated reporting (aggregated overview per operation/affiliate and not per individual user).

Affiliates can use API to get reports related to the activities of their own traffic and for the Operator to have access to all affiliates' data.

hashtag
API for the Affiliate

hashtag
Accessing analytical data

The Affiliation system has an API endpoint that provides statistical information about visits, registrations, commissions, etc., aggregated by a specified period or for a lifetime.

Example of the API call using CURL:

curl --location --request GET 'https://boapi.smartico.ai/api/af2_media_report_af?aggregation_period=DAY&group_by=utm_campaign,utm_medium,utm_source,afp&date_from=2022-07-12&date_to=2022-07-14' --header 'authorization: your_api_key'

Example of API call using NodeJs:

var request = require('request');
var options = {
 'method': 'GET',
 'url': 'https://boapi.smartico.ai/api/af2_media_report_af?aggregation_period=DAY',
 'headers': {
   'authorization': 'your_api_key'
 }
};
request(options, function (error, response) {
 if (error) throw new Error(error);
 console.log(response.body);
});

Parameters in API call:

  • As aggregation_period you can pass DAY, MONTH, YEAR, or keep it empty in order to get aggregate data for the lifetime.

  • Optional parameter group_by could have a comma-separated list of the fields to group results. Possible values are:

    • utm_campaign

    • utm_medium

    • utm_source

    • afp, afp1, afp2.... afp9

    • link_id

    • brand_id

    • campaign_id

    • source_id

    • deal_root_original_id

    • registration_id (requires "Registrations report" permissions)

    • ext_customer_id (requires "Registrations report" permissions)

    • username (requires "Registrations report" permissions)

  • Optional parameters date_from and date_to could be used to limit results for the defined period. The format of the date is YYYY-MM-DD

triangle-exclamation

Important note regarding setting date_from and date_to parameters.

  • date_from is inclusive

  • date_to is exclusive

This means that for the request with date_from = 2022-07-12 and date_to=2022-07-14, API will return data for 12 and 13 July only.

Example of response:

Report in the UI

hashtag
API for the Operator

hashtag
Accessing analytical data

Operator API is similar to the Affiliate API.

Example of the API call using CURL:

The difference between APIs:

.
Affiliate API
Operator API

Method name

af2_media_report_af

af2_media_report_op

Possible values for group_by parameter

afp(1..9), utm_campaign, utm_medium', utm_source, link_id, brand_id, source_id, campaign_id, registration_id, ext_customer_id, username

affiliate_id, registration_id, ext_customer_id, username, afp(1..9), utm_campaign, utm_medium, utm_source, link_id, brand_id, campaign_id, source_id, deal_root_original_id, child_affiliate_id, manager_id

Possible values for filtering data

date_from, date_to

date_from, date_to, affiliate_id, brand_id

hashtag
Important to know

  • All amounts are in operator currency

  • As TAP is providing an affiliation system as a white-label solution, you can find the name, domain, and image of the “Operator” operating affiliation system in response to API calls.

  • In grouping by "day", the report will show the change of commission during this day. It's not a total commission at the end of the day.

  • If you are querying aggregated data and there are no activities for a specific period, the record for a specific period will be missing in response. Note that not all attributes are available for every affiliate. Visibility depends on the Additional Permissions granted to each Affiliate

  • If you query for aggregated data, the response will show only changes for a specified period. Given the example in the image below, you should treat it in the following way:

    • During July, the affiliate had a change of balance “-795.50 EUR”, and because it was his first month, at the end of the month, his balance will be -795.50 EUR

    • During August, he had a positive change, +225 EUR. This means that his balance was “-570.50 EUR at the end of August.”

  • "manager_id" value can be passed as 123 or as 123,456

Example of rolling change of balance

PreviousRegistration APINextBalance and Payment API

Last updated

Was this helpful?