Home B2Core IB API Reports

Reports

On this page:

GET[base]/reports/clicks	Get a click report
GET[base]/reports/payments	Get a payment report

Get a click report

Use this method to obtain an acquisition report.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters:

group_by string required

The criteria for grouping the filtered data. Possible values:

user
country
region
referrer
hour
day
week
month
year

This method supports pagination, sorting, and filtering and query. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting and query are listed below.

Possible values for the filter parameter:

userId — information about a partner
groupId — information about a partnership program
reportStartTime
reportEndTime

Possible values for the sort_by parameter:

time (default)

GET[base]/reports/clicks

curl --location -g --request GET 'https://your.base-url.here/reports/clicks?limit=10&offset=0&sort_by=time&group_by=day&sort_order=desc&filter[endTime]=2021-01-31T23:59:59+00:00&filter[startTime]=2021-01-01T00:00:00+00:00&filter[groupId]=6006dda272f002519c3eb505&filter[userId]=6006dda272f002519c3eb505' \
--header 'Authorization: Bearer <token>'

Response

Body:

aggregation object

The total values and changes of report parameters during the reporting period.

clickConversionRate object

The click conversion rate, which is the number of registrations divided by the number of clicks.

Expand fields

actualValue string: The current value of click conversion rate.
absoluteChange string: The difference between click conversion rate values at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

numberOfActiveUsers object

The number of partners whose clients have executed at least one trade during the reporting period.

Expand fields

actualValue integer: The current number of active partners.
absoluteChange integer: The difference between numbers of active partners at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

numberOfClicks object

The number of all clicks made during the reporting period.

Expand fields

actualValue integer: The current number of clicks made on the referral links of your partners.
absoluteChange integer: The difference between numbers of clicks at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

numberOfLeads object

The number of all client registrations made during the reporting period.

Expand fields

actualValue integer: The current number of client registrations by the referral links of your partners.
absoluteChange integer: The difference between numbers of client registrations at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

data array

The current values of report parameters.

name string: The report name. By default: the current date.
startTime string: The date and time of the beginning of the reporting period.
endTime string: The date and time of the end of the reporting period.
numberOfActiveUsers integer: The current number of active partners.
numberOfClicks integer: The current number of clicks made on the referral links of your partners.
numberOfLeads integer: The current number of client registrations.
clickConversionRate string: The click conversion rate, which is the number of registrations divided by the number of clicks.

    RESPONSE BODY EXAMPLE
  
{
  "report": {
    "aggregation": {
      "clickConversionRate": {
        "actualValue": "0.285714285714285714",
        "absoluteChange": "0.142857142857142857",
        "relativeChange": "100.000000000000000000"
      },
      "numberOfActiveUsers": {
        "actualValue": 2,
        "absoluteChange": 1,
        "relativeChange": "100.000000000000000000"
      },
      "numberOfClicks": {
        "actualValue": 2,
        "absoluteChange": 1,
        "relativeChange": "100.000000000000000000"
      },
      "numberOfLeads": {
        "actualValue": 2,
        "absoluteChange": 1,
        "relativeChange": "100.000000000000000000"
      }
    },
    "data": [
      {
        "name": "Fri., Jan. 1, 2021",
        "startTime": "2021-01-01T00:00:00+00:00",
        "endTime": "2021-01-01T23:59:59+00:00",
        "numberOfActiveUsers": 2,
        "numberOfClicks": 7,
        "numberOfLeads": 2,
        "clickConversionRate": "0.285714285714285714"
      },
      {
        "name": "Fri., Jan. 1, 2021",
        "startTime": "2021-01-01T00:00:00+00:00",
        "endTime": "2021-01-01T23:59:59+00:00",
        "numberOfActiveUsers": 2,
        "numberOfClicks": 7,
        "numberOfLeads": 2,
        "clickConversionRate": "0.285714285714285714"
      }
    ]
  }
}

Get a payment report

Use this method to obtain a payment report.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters:

group_by string required

The criteria for grouping the filtered data. Possible values:

user
hour
day
week
month
year

Possible values for the filter parameter:

userId — information about a partner
groupId — information about an IB type
reportStartTime
reportEndTime

Possible values for the sort_by parameter:

time (default)

GET[base]/reports/payments

curl --location -g --request GET 'https://your.base-url.here/reports/payments?limit=10&offset=0&sort_by=time&group_by=day&sort_order=desc&filter[endTime]=2021-01-31T23:59:59+00:00&filter[startTime]=2021-01-01T00:00:00+00:00&filter[groupId]=6006dda272f002519c3eb505&filter[userId]=6006dda272f002519c3eb505' \
--header 'Authorization: Bearer <token>'

Response

Body:

aggregation object

The total values and changes of report parameters during the reporting period.

numberOfActiveUsers object

The number of partners whose clients have executed at least one trade during the reporting period.

Expand fields

actualValue integer: The current number of active partners.
absoluteChange integer: The difference between numbers of active partners at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

numberOfActiveCustomers object

The number of active traders brought by your partners during the reporting period.

Expand fields

actualValue integer: The current number of active traders brought by your partners.
absoluteChange integer: The difference between numbers of active traders at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

numberOfTrades object

The number of trades executed during the reporting period.

Expand fields

actualValue integer: The current number of trades.
absoluteChange integer: The difference between numbers of trades at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.

tradingVolume object

The number of lots traded during the reporting period.

Expand fields

actualValue string: The current number of traded lots.
absoluteChange string: The difference between numbers of traded lots at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.
unit string: The currency of trades.

paymentAmount object

The amount of rewards paid to your partners during the reporting period.

Expand fields

actualValue string: The current amount of paid rewards.
absoluteChange string: The difference between amounts of paid rewards at the beginning and in the end of the reporting period.
relativeChange string: The absolute change as a percentage value.
unit string: The currency of a reward payment.

data array

The current values of report parameters.

name string: The report name. By default: the current date.
startTime string: The date and time of the beginning of the reporting period.
endTime string: The date and time of the end of the reporting period.
numberOfActiveUsers integer: The current number of active partners.
numberOfActiveCustomers integer: The current number of active traders brought by your partners.
numberOfTrades integer: The number of trades executed during the reporting period.
tradingVolume string: The number of lots traded during the reporting period.
paymentCurrencyCode string: The currency of reward payments.
paymentAmount string: The amount of rewards paid to your partners during the reporting period.

    RESPONSE BODY EXAMPLE
  
{
  "report": {
    "aggregation": {
      "numberOfActiveUsers": {
        "actualValue": 3,
        "absoluteChange": -1,
        "relativeChange": "-25.000000000000000000"
      },
      "numberOfActiveCustomers": {
        "actualValue": 3,
        "absoluteChange": -1,
        "relativeChange": "-25.000000000000000000"
      },
      "numberOfTrades": {
        "actualValue": 3,
        "absoluteChange": -1,
        "relativeChange": "-25.000000000000000000"
      },
      "tradingVolume": {
        "actualValue": "1.200000000000000000",
        "absoluteChange": "0.640000000000000000",
        "relativeChange": "114.285714285714285700",
        "unit": "lot"
      },
      "usdTradingVolume": {
        "actualValue": 3,
        "absoluteChange": -1,
        "relativeChange": "-25.000000000000000000"
      },
      "paymentAmount": {
        "actualValue": "1.200000000000000000",
        "absoluteChange": "0.640000000000000000",
        "relativeChange": "114.285714285714285700",
        "unit": "GBP"
      }
    },
    "data": [
      {
        "name": "Fri., Jan. 1, 2021",
        "startTime": "2021-01-01T00:00:00+00:00",
        "endTime": "2021-01-01T23:59:59+00:00",
        "numberOfActiveUsers": 2,
        "numberOfActiveCustomers": 2,
        "numberOfTrades": 2,
        "tradingVolume": "1.000000000000000000",
        "usdTradingVolume": "1.000000000000000000",
        "paymentCurrencyCode": "GBP",
        "paymentAmount": "1.000000000000000000"
      }
    ]
  }
}