Partner API

Introduction

The Text Partner API provides a RESTful interface that enables partners to programmatically access and manage their partnership data. Use this API to retrieve earnings reports, manage customer licenses, and oversee affiliate campaigns.

API status

GET https://api.livechatinc.com/v2/partners/status

Authorization

Partner authentication uses API tokens, which you can generate within the Partner App. Include these tokens in the Authorization header of your HTTP requests to authenticate and authorize access to the API endpoints.

You can create your token in the API tokens section.

Available methods


Account	`get_profile` `update_profile` `get_stats` `get_coupons` `get_earnings` `get_commission_report` `get_partners_referred_earnings_report` `get_billing` `get_balance` `get_commission_metric` `update_billing` `request_withdrawal` `get_withdrawals` `create_api_token` `get_api_tokens` `revoke_api_token`
Affiliate Partner	`create_campaign` `search_campaigns` `get_campaigns` `disable_campaign` `get_affiliate_licenses` `get_performance_report` `get_partners_referred` `get_affiliate_links` `get_trials_metrics` `get_earnings_metrics` `get_conversions_metrics` `get_clicks_metrics` `get_referred_partners_commission_metrics` `get_trials_report` `get_earnings_report` `get_conversions_report` `get_clicks_report` `get_campaigns_earnings_metric` `get_campaigns_earnings_report` `get_campaigns_summary` `get_best_performing_campaigns_clicks_report` `get_best_performing_campaigns_trials_report` `get_best_performing_campaigns_conversions_report` `get_best_performing_campaigns_earnings_report` `get_best_performing_campaigns_clicks_metrics` `get_best_performing_campaigns_trials_metrics` `get_best_performing_campaigns_conversions_metrics` `get_best_performing_campaigns_earnings_metrics` `get_summary`
Solution Partner	`create_organization` `get_organization_licenses` `get_organization_details` `create_license` `get_solution_licenses` `get_solution_licenses_by_status` `get_license_details` `update_license_details` `invite_license_operators` `get_license_invoices` `get_license_invoice_pdf` `create_subscription` `update_subscription` `close_subscription` `update_license_billing` `transfer_license` `get_recurly_token` `get_license_metrics` `get_solution_licenses_report` `get_solution_licenses_csv_report` `get_leads` `get_lead_details` `get_lead_history` `submit_lead` `get_solution_summary`
Partner Directory	`upload_logo` `create_expert_profile` `get_expert_profile` `update_expert_profile` `get_comments` `get_expert_stats` `get_expert_history`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

Postman Collection

You can find all the requests from the Partner API in Postman. In our collection, we use environment variables for the API token - remember to replace it with your own.

Account

Get Profile

Returns the profile information for the authenticated partner.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "partner_id": "xyz",
  "login": "joe@email.com",
  "first_name": "Joe",
  "last_name": "Doe",
  "contact_name": "Jane Doe",
  "contact_email": "jane@email.com",
  "solution_status": "accepted",
  "properties": {
  "sales_kit_popup_closed": true,
  "pitch_deck_downloaded": true,
  "tier2_popup_closed": true,
  "payment_origin_popup_closed": true
  // and more properties (used for showing popups in Partners App)
  }
}

Update Profile

Updates the profile information for the authenticated partner.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/profile`

Request

Parameter	Required	Data type	Notes
`first_name`	Yes	`string`	The first name.
`last_name`	Yes	`string`	The last name.
`contact_name`	Yes	`string`	The contact name.
`contact_email`	Yes	`string`	The contact email.
`send_monthly_summary`	No	`bool`	If `true`, opt-in for a monthly summary.
`send_reseller_weekly_summary`	No	`bool`	If `true`, opt-in for a weekly reseller summary.
`send_newsletter`	No	`bool`	If `true`, opt-in for the partner newsletter.
`send_notifications`	No	`bool`	If `true`, opt-in for notifications.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request PUT \
  --url https://api.livechatinc.com/v2/partners/profile \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Joe",
    "last_name": "Doe",
    "contact_name": "Jane Doe",
    "contact_email": "jane@email.com"
  }'

Get Stats

Returns the number of licenses for each product and partnership model.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/stats`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/stats \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "affiliate": {
    "livechat": {
    "trials": 120,
    "trials_cc": 38,
    "paid": 41
  },
  "chatbot": {
    "trials": 96,
    "trials_cc": 52,
    "paid": 34
  },
  "helpdesk": {
    "trials": 21,
    "trials_cc": 37,
    "paid": 47
  },
  "partner_program": {
    "partners_referred": 63,
    "trials": 42,
    "trials_cc": 24,
    "paid": 37
  }
  },
  "solution": {
    "livechat": {
    "trials": 12,
    "trials_cc": 7,
    "paid": 28
  },
  "chatbot": {
    "trials": 51,
    "trials_cc": 21,
    "paid": 19
  },
  "helpdesk": {
    "trials": 21,
    "trials_cc": 37,
    "paid": 47
  }
  }
}

Get Coupons

Returns the list of active coupons.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/coupons`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/coupons \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "id": 1,
      "label": "30% off first payment"
    },
    {
      "id": 2,
      "label": "$25 discount"
    }
  ]
}

Get Earnings

Returns earnings information including commission earned, balance, blocked and pending amounts, and more.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/earnings`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/earnings \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "balance": 2552,
  "blocked": 0,
  "commission_total": 16519.12,
  "commission_last_30_days": 61.34,
  "withdrawals": 0,
  "pending": 13546,
  "affiliate": {
    "commission_total": 16098,
    "commission_last_30_days": 0,
    "livechat": {
      "commission_total": 15942,
      "commission_last_30_days": 0
    },
    "chatbot": {
      "commission_total": 0,
      "commission_last_30_days": 0
    },
    "partner_program": {
      "commission_total": 156,
      "commission_last_30_days": 0
    }
  },
  "solution": {
    "commission_total": 421.12,
    "commission_last_30_days": 61.34,
    "livechat": {
      "discount": 45943.76,
      "commission_total": 0,
      "commission_last_30_days": 0
    },
  "chatbot": {
      "discount": 0,
      "commission_total": 421.12,
      "commission_last_30_days": 61.34
    }
  }
}

Get Commission Report

Returns commission reports.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/reports/commission`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get the report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get the report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`filters`	No	`string`	URL-encoded filters. An array of objects with `field`, `value`, and `operator` properties.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/reports/commission?date_from=2022-12-15T00:00:00Z&date_to=2023-02-14T23:59:59Z&aggregation=month&filters=%5B%7B%22field%22%3A%22product%22%2C%22value%22%3A%22livechat%22%2C%22operator%22%3A%22equals%22%7D%5D \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "items": [
    {
      "date_range": {
        "from": "2022-12-01 00:00:00",
        "to": "2022-12-31 23:59:59"
      },
      "total": 6326.39
    },
    {
      "date_range": {
        "from": "2023-01-01 00:00:00",
        "to": "2023-01-31 23:59:59"
      },
      "total": 4949.1
    },
    {
      "date_range": {
        "from": "2023-02-01 00:00:00",
        "to": "2023-02-28 23:59:59"
      },
    "total": 7824.5
    }
  ]
}

Get Partners Referred Earnings Report

Returns the commission earned from referring partners.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/partners-referred/reports/commission`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get the report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get the report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.
`product`	No	`string`	The product to get the report for. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.
`program`	No	`string`	The program to get the report for. Possible values: `affiliate`, `solution`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/partners-referred/reports/commission?aggregation=month&date_from=2022-03-25T00:00:00Z&date_to=2022-05-04T00:00:00Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "date_range": {
                "from": "2022-03-01 00:00:00",
                "to": "2022-03-31 23:59:59"
            },
            "total": 885.58
        },
        {
            "date_range": {
                "from": "2022-04-01 00:00:00",
                "to": "2022-04-30 23:59:59"
            },
            "total": 347.94
        },
        {
            "date_range": {
                "from": "2022-05-01 00:00:00",
                "to": "2022-05-31 23:59:59"
            },
            "total": 1413.69
        }
    ]
}

Get Billing

Returns billing information.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/billing`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/billing \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "company": "Awesome Company",
  "vat": "123",
  "address": "Wall Street 123",
  "city": "New York",
  "zip_code": "10005",
  "country": "US",
  "paypal": "paypal@email.com",
  "type": "business"
}

Get Balance

Returns balance information.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/balance`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/balance \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "pending": 21.00,
  "withdrawn": 37.00,
  "available": 362.00,
  "total": "420.00"
}

Get Commission Metric

Returns the commission metric.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/metrics/commission`

Request

Parameter	Required	Data type	Notes
`date_from`	No	`string`	The date to get the commission metric from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	No	`string`	The date to get the commission metric up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`product`	No	`string`	The product to get the commission metric for. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.
`program`	No	`string`	The program to get the commission metric for. Possible values: `solution`, `affiliate`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/metrics/commission?date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z&product=livechat&program=solution \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "value": 1232.12
}

Update Billing

Updates billing information.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/billing`

Request

Parameter	Required	Data type	Notes
`type`	Yes	`string`	The type. Possible values: `business`, `individual`.
`company`	Yes	`string`	The company name (if business) or full name (if individual).
`address`	Yes	`string`	The address.
`city`	Yes	`string`	The city.
`country`	Yes	`string`	The country code. Possible values.
`paypal`	Yes	`string`	The PayPal login (email).
`zip_code`	No	`string`	The ZIP / Postal code.
`vat`	No	`string`	The VAT.
`state`	No	`string`	The state.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request PUT \
  --url https://api.livechatinc.com/v2/partners/billing \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "business",
    "company": "Awesome Company",
    "address": "Wall Street 123",
    "city": "New York",
    "country": "US",
    "paypal": "paypal@email.com"
  }'

Request Withdrawal

Creates a withdrawal request.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/withdrawals`

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/withdrawals \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "withdrawal_id": 2,
  "request_timestamp": "2018-03-06 12:24:42",
  "action_timestamp": "",
  "status": "pending",
  "amount": 1520,
  "invoice_id": "2018/2/xyz",
  "paypal": "joe@doe.com"
}

Get Withdrawals

Returns the list of withdrawals.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/withdrawals`

Request

Parameter	Required	Data type	Notes
`date_from`	No	`string`	The date to get the report on withdrawals from. Date format: `YYYY-MM-DD`.
`date_to`	No	`string`	The date to get the report on withdrawals up to. Date format: `YYYY-MM-DD`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/withdrawals \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
    "withdrawal_id": 2,
      "request_timestamp": "2018-03-06 12:24:42",
      "action_timestamp": "",
      "status": "pending",
      "amount": 1520,
      "invoice_id": "2018/2/xyz",
    "paypal": "joe@doe.com"
    },
    {
    "withdrawal_id": 1,
      "request_timestamp": "2018-02-02 11:43:37",
      "action_timestamp": "2018-02-02 12:04:11",
      "status": "paid",
      "amount": 1063.3,
      "invoice_id": "2018/1/xyz",
    "paypal": "joe@doe.com"
    }
  ]
}

Create API Token

Creates a new API token.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/tokens`

Request

Parameter	Required	Data type	Notes
`label`	Yes	`string`	A custom label for the token (min. 3 characters).

EXAMPLE REQUEST

Copied!

curl --request POST \
  --data 'label=My first API token' \
  --url https://api.livechatinc.com/v2/partners/tokens \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "id": 1,
  "token": "secrettokengeneratedbyapi...",
  "creation_timestamp": "2018-03-06 15:14:26",
  "label": "My first API token"
}

Get API Tokens

Returns the list of active API tokens.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/tokens`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/tokens \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "id": 2,
      "token": "anothersecrettokengeneratedbyapi...",
      "creation_timestamp": "2018-03-06 17:14:26",
      "label": "Token for my service"
    },
    {
      "id": 1,
      "token": "secrettokengeneratedbyapi...",
      "creation_timestamp": "2018-03-06 15:14:26",
      "label": "My first API token"
    }
  ]
}

Revoke API Token

Revokes an API token.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/tokens/<id>`

Request

Parameter	Required	Data type	Notes
`<id>`	Yes	`string`	The token ID.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request DELETE \
  --url https://api.livechatinc.com/v2/partners/tokens/1 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

Affiliate Partner

Create Campaign

Creates a new campaign.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns`

Request

Parameter	Required	Data type	Notes
`product`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`, `partner_program`.
`name`	Yes	`string`	The campaign name (min. 5, max. 100 characters).
`link`	Yes	`string`	The URL of the product landing page (default: product homepage).
`trial_duration`	Yes	`int`	The number of days of the trial period (min. 14 - default, max. 30).
`coupon_id`	No	`int`	The ID of the coupon assigned to a Partner (a discount will be applied).

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns?product=livechat \
  --data 'name=New campaign&link=https://www.livechat.com/features/&trial_duration=30&coupon_id=1' \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "product": "livechat",
  "name": "New campaign",
  "slug": "pp_new-campaign",
  "url": "https://www.livechat.com/features/?a=xyz&utm_campaign=pp_new-campaign",
  "short_url": "https://lc.chat/abc",
  "creation_timestamp": "2018-03-06 11:30:40",
  "trial_duration": 30,
  "discount": "$25 discount"
}

// Note - `slug` is a URL-friendly campaign name with `pp_` prefix

Search Campaigns

Searches for campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/search`

Request

Parameter	Required	Data type	Notes
`page`	Yes	`int`	The pagination page number.
`state`	Yes	`string`	The state. Possible values: `active`, `archived`.
`product`	No	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.
`filters`	No	`string`	An array of objects with `field`, `value`, and `operator` properties.
`sort_by`	No	`string`	The field to sort by. Possible values: `creation_timestamp`.
`sort_order`	No	`string`	The sort order. Possible values: `desc`, `asc`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/search?page=1&product=all&state=active&filters=[]&&sort_order=desc&sort_by=creation_timestamp \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "value": 123.00,
    "results": [
        {
            "id": 123,
            "name": "campaign-test-name",
            "product": "chatbot",
            "created_at": "2023-01-01 11:22:59",
            "landing_page_url": "https://staging.chatbot.com/features",
            "slug": "pp-campaign-test-name",
            "is_default": false,
            "region": "dal",
            "offer": null
        }
    ],
    "total": 120, // represents total number of campaigns
    "limit": 15, // represents number of campaigns per page
}

Get Campaigns

Returns campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns`

Request

Parameter	Required	Data type	Notes
`state`	No	`string`	The state. Possible values: `active` (default), `disabled`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
    "active": true,
    "product": "livechat",
      "name": "Hello World!",
      "slug": "pp_hello-world",
      "url": "https://www.livechat.com/pricing/?a=xyz&utm_campaign=pp_hello-world&utm_source=PP",
      "short_url": "https://lc.chat/abc",
      "creation_timestamp": "2018-03-06 23:42:19",
      "trial_duration": 30,
      "discount": "30% off first payment",
    },
    {
    "active": true,
    "creation_timestamp": "2019-11-21 14:22:14",
    "name": "Test Campaign",
    "product": "chatbot",
    "short_url": "https://lc.chat/xyz",
    "slug": "pp_test-campaign",
    "trial_duration": 7,
    "url": "https://chatbot.com/?a=xyzK&utm_campaign=pp_test-campaign&utm_source=PP"
    }
  ]
}

// Note - `slug` is a URL-friendly campaign name with `pp_` prefix

Disable Campaign

Disables a campaign.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/<campaign_id>`

Request

Parameter	Required	Data type	Notes
`<campaign_id>`	Yes	`string`	The campaign ID.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request DELETE \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/123 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

Get Affiliate Licenses

Returns the list of Affiliate licenses.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/licenses`

Request

Parameter	Required	Data type	Notes
`date_from`	No	`string`	The date to get licenses created from. Date format: `YYYY-MM-DD`.
`date_to`	No	`string`	The date to get licenses created up to. Date format: `YYYY-MM-DD`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/licenses \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "product": "livechat",
      "creation_timestamp": "2019-10-25 14:55:57",
      "end_timestamp": "2019-11-25 12:55:54",
      "active": true,
      "ql": true,
      "cc_added": false,
      "paid": false,
      "commission_percent": 20,
      "earnings": 0,
      "blocked": false,
      "campaign_name": "",
      "utm_campaign": "",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": ""
    },
    {
      "product": "chatbot",
      "creation_timestamp": "2019-09-05 15:51:39",
      "end_timestamp": "2019-10-05 13:51:39",
      "active": true,
      "ql": true,
      "cc_added": true,
      "paid": true,
      "commission_percent": 20,
      "earnings": 18.2,
      "blocked": false,
      "campaign_name": "",
      "utm_campaign": "",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": ""
    }
  ]
}

Get Performance Report

Returns the Affiliate's performance report.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/performance`

Request

Parameter	Required	Data type	Notes
`date_from`	No	`string`	The date to get a report for licenses created from. Date format: `YYYY-MM-DD`.
`date_to`	No	`string`	The date to get a report for licenses created up to. Date format: `YYYY-MM-DD`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/performance \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "product": "livechat",
      "campaign_name": "Newsletter",
      "utm_campaign": "pp_newsletter",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": "",
      "clicks": 141,
      "trials": 58,
      "qls": 47,
      "paid": 24,
      "partners_referred": 0,
      "commission": 7284.2
    },
    {
      "product": "partner_program",
      "campaign_name": "ad",
      "utm_campaign": "pp_ad",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": "",
      "clicks": 154,
      "trials": 0,
      "qls": 0,
      "paid": 0,
      "partners_referred": 123,
      "commission": 3141
    },
    {
      "product": "chatbot",
      "campaign_name": "AI Campaign",
      "utm_campaign": "pp_ai-campaign",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": "",
      "clicks": 72,
      "trials": 41,
      "qls": 17,
      "paid": 23,
      "partners_referred": 0,
      "commission": 1961.6
    }
  ]
}

Get Partners Referred

Returns the list of referred Partners.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/partners-referred`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/partners-referred \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "partner_id": "W-5ZzZyiR",
      "creation_timestamp": "2019-08-21 10:02:44",
      "active_trials": 10,
      "active_trials_cc_added": 14,
      "total_trials": 41,
      "active_paid": 8,
      "total_paid": 8,
      "commission": 5124.2,
      "campaign_name": "",
      "utm_campaign": "",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": ""
  },
    {
      "partner_id": "BqgFtQEmR",
      "creation_timestamp": "2019-08-14 16:24:12",
      "active_trials": 16,
      "active_trials_cc_added": 4,
      "total_trials": 51,
      "active_paid": 19,
      "total_paid": 20,
      "commission": 6815,
      "campaign_name": "My awesome campaign",
      "utm_campaign": "pp_my_awesome_campaign",
      "utm_medium": "",
      "utm_content": "",
      "utm_term": ""
    }
  ]
}

Get Affiliate Links

Returns affiliate links (long and short version) for default campaigns of each product.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/links`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/links \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "livechat": {
        "url": "https://www.livechat.com/?a=JXkcUIvMR&utm_source=PP",
        "short_url": "https://lc.chat/pTQxp"
    },
    "chatbot": {
        "url": "https://www.chatbot.com/?a=JXkcUIvMR&utm_source=PP",
        "short_url": "https://lc.chat/Xm6qW"
    },
    "partner_program": {
        "url": "https://partners.livechat.com/?a=JXkcUIvMR&utm_source=PP",
        "short_url": "https://lc.chat/xzrKk"
    }
}

Get Trials Metrics

Returns the number of trials generated from Affiliate campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/metrics/trials`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get trials metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get trials metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/metrics/trials?date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "value": 99
}

Get Earnings Metrics

Returns earnings generated from Affiliate campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/metrics/earnings`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get earnings metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get earnings metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`product`	No	`string`	The product to get earnings metrics for. Possible values: `livechat`, `chatbot`, `helpdesk`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/metrics/earnings?date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z&product=livechat \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "value": 123.45
}

Get Conversions Metrics

Returns the number of trials converted into paid licenses generated from Affiliate campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/metrics/conversions`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get conversions metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get conversions metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`product`	No	`string`	The product to get conversions metrics for. Possible values: `livechat`, `chatbot`, `helpdesk`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/metrics/conversions?date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "value": 123
}

Get Clicks Metrics

Returns clicks generated from Affiliate campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/metrics/clicks`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get clicks metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get clicks metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`product`	No	`string`	The product to get clicks metrics for. Possible values: `livechat`, `chatbot`, `helpdesk`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/metrics/clicks?date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "value": 123
}

Get Referred Partners Commission Metrics

Returns commission generated from referred partners' activity.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/partners-referred/metrics/commission`

Request

Parameter	Required	Data type	Notes
`date_from`	No	`string`	The date to get commission metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	No	`string`	The date to get commission metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`product`	No	`string`	The product to get commission metrics for. Possible values: `livechat`, `chatbot`, `helpdesk`, `partner_program`, `all`. Default: `all`.
`program`	No	`string`	The program to get commission metrics for. Possible values: `solution`, `affiliate`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/partners-referred/metrics/commission?date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z&product=livechat&program=solution \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "value": 123.45
}

Get Trials Report

Returns trials report for the Affiliate activity over time (up to last 12 months).

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/reports/trials`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get the report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get the report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.
`product`	No	`string`	The product to get the report for. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/reports/trials?date_from=2022-02-15T00:00:00Z&date_to=2023-02-14T23:59:59Z&aggregation=month&product=livechat \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "items": [
    {
      "date_range": {
        "from": "2023-02-12 00:00:00",
        "to": "2023-02-12 23:59:59"
      },
      "total": 3
    },
    {
      "date_range": {
        "from": "2023-02-13 00:00:00",
        "to": "2023-02-13 23:59:59"
      },
      "total": 5
    },
    {
      "date_range": {
        "from": "2023-02-14 00:00:00",
        "to": "2023-02-14 23:59:59"
      },
      "total": 0
    }
  ]
}

Get Earnings Report

Returns earnings report for the Affiliate activity over time (up to last 12 months).

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/reports/earnings`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get the report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get the report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.
`product`	No	`string`	The product to get the report for. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/reports/earnings?date_from=2022-12-15T00:00:00Z&date_to=2023-02-14T23:59:59Z&aggregation=month&product=livechat \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "items": [
    {
      "date_range": {
        "from": "2022-12-01 00:00:00",
        "to": "2022-12-31 23:59:59"
      },
      "total": 6326.39
    },
    {
      "date_range": {
        "from": "2023-01-01 00:00:00",
        "to": "2023-01-31 23:59:59"
      },
      "total": 4949.1
    },
    {
      "date_range": {
        "from": "2023-02-01 00:00:00",
        "to": "2023-02-28 23:59:59"
      },
    "total": 7824.5
    }
  ]
}

Get Conversions Report

Returns conversions report for the Affiliate activity over time (up to last 12 months).

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/reports/conversions`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get the report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get the report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.
`product`	No	`string`	The product to get the report for. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/reports/conversions?date_from=2023-01-21T00:00:00Z&date_to=2023-02-11T23:59:59Z&aggregation=week&product=chatbot \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "items": [
    {
      "date_range": {
        "from": "2023-01-16 00:00:00",
        "to": "2023-01-22 23:59:59"
      },
      "total": 6
    },
    {
      "date_range": {
        "from": "2023-01-23 00:00:00",
        "to": "2023-01-29 23:59:59"
      },
        "total": 3
    },
    {
      "date_range": {
        "from": "2023-01-30 00:00:00",
        "to": "2023-02-05 23:59:59"
      },
      "total": 0
    },
    {
      "date_range": {
        "from": "2023-02-06 00:00:00",
        "to": "2023-02-12 23:59:59"
      },
      "total": 1
    }
  ]
}

Get Clicks Report

Returns clicks report for the Affiliate activity over time (up to last 12 months).

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/reports/clicks`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	The date to get the report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get the report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.
`product`	No	`string`	The product to get the report for. Possible values: `livechat`, `chatbot`, `helpdesk`, `all`. Default: `all`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/reports/clicks?date_from=2023-03-25T00:00:00Z&date_to=2023-03-26T23:59:59Z&aggregation=day&product=all \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "items": [
    {
      "date_range": {
        "from": "2023-03-25 00:00:00",
        "to": "2023-03-25 23:59:59"
      },
      "total": 0
    },
    {
      "date_range": {
        "from": "2023-03-26 00:00:00",
        "to": "2023-03-26 23:59:59"
      },
      "total": 1
    }
  ]
}

Get Campaigns Earnings Metric

Returns the affiliate campaign earnings metric.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/<campaign_id>/metrics/earnings`

Request

Parameter	Required	Data type	Notes
`<campaign_id>`	Yes	`string`	The campaign ID.
`date_from`	Yes	`string`	The date to get earnings metrics from. Date format: `YYYY-MM-DD`.
`date_to`	Yes	`string`	The date to get earnings metrics up to. Date format: `YYYY-MM-DD`.
`billing_cycle`	No	`string`	The billing cycle. Possible values: `monthly`, `annual`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/54321/metrics/earnings?date_from=2022-01-01&date_to=2022-12-01&billing_cycle=annual \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "value": 37.21
}

Get Campaigns Earnings Report

Returns the affiliate campaign earnings report.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/<campaign_id>/reports/earnings`

Request

Parameter	Required	Data type	Notes
`<campaign_id>`	Yes	`string`	The campaign ID.
`date_from`	Yes	`string`	The date to get earnings metrics from. Date format: `YYYY-MM-DD`.
`date_to`	Yes	`string`	The date to get earnings metrics up to. Date format: `YYYY-MM-DD`.
`billing_cycle`	Yes	`string`	The billing cycle. Possible values: `monthly`, `annual`.
`aggregation`	Yes	`string`	The timespan by which to aggregate the report. Possible values: `day`, `week`, `month`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/54321/reports/earnings?date_from=2022-01-01&date_to=2022-12-01&billing_cycle=annual&aggregation=month \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "date_range": {
                "from": "2022-03-01 00:00:00",
                "to": "2022-03-31 23:59:59"
            },
            "total": 12
        },
        {
            "date_range": {
                "from": "2022-04-01 00:00:00",
                "to": "2022-04-30 23:59:59"
            },
            "total": 34
        },
        {
            "date_range": {
                "from": "2022-05-01 00:00:00",
                "to": "2022-05-31 23:59:59"
            },
            "total": 56
        }
    ]
}

Get Campaigns Summary

Returns the affiliate campaigns summary.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/<campaign_id>/summary`

Request

Parameter	Required	Data type	Notes
`<campaign_id>`	Yes	`string`	The campaign ID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/54321/summary \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "click": 21,
    "trial": 37,
    "paid": 42,
    "earnings": 3127.00
}

Get Best Performing Campaigns Clicks Report

Returns clicks report for a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/clicks`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get clicks report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get clicks report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/clicks?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "id": 123,
            "name": "campaign_123",
            "value": 300,
            "product": "chatbot"
        },
        {
            "id": 456,
            "name": "campaign_456",
            "value": 400,
            "product": "livechat"
        }
    ]
}

Get Best Performing Campaigns Trials Report

Returns trials report for a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/trials`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get trials report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get trials report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/trials?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "id": 123,
            "name": "campaign_123",
            "value": 300,
            "product": "chatbot"
        },
        {
            "id": 456,
            "name": "campaign_456",
            "value": 400,
            "product": "livechat"
        }
    ]
}

Get Best Performing Campaigns Conversions Report

Returns conversions report for a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/conversions`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get conversions report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get conversions report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/conversions?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "id": 123,
            "name": "campaign_123",
            "value": 300,
            "product": "chatbot"
        },
        {
            "id": 456,
            "name": "campaign_456",
            "value": 400,
            "product": "livechat"
        }
    ]
}

Get Best Performing Campaigns Earnings Report

Returns earnings report for a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/earnings`

Request

Parameter	Required	Data type	Notes
`limit`	No	`int`	The number of campaigns to return.
`date_from`	No	`string`	The date to get earnings report from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	No	`string`	The date to get earnings report up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/earnings?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "id": 123,
            "name": "campaign_123",
            "value": 300.10,
            "product": "chatbot"
        },
        {
            "id": 456,
            "name": "campaign_456",
            "value": 400.10,
            "product": "livechat"
        }
    ]
}

Get Best Performing Campaigns Clicks Metrics

Returns summarized number of clicks generated from a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/clicks`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get clicks metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get clicks metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/clicks?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "value": 123
}

Get Best Performing Campaigns Trials Metrics

Returns summarized number of trials generated from a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/trials`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get trials metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get trials metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/trials?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "value": 123
}

Get Best Performing Campaigns Conversions Metrics

Returns summarized number of trials converted into paid licenses generated from a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/conversions`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get conversions metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get conversions metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/conversions?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "value": 123
}

Get Best Performing Campaigns Earnings Metrics

Returns summarized earnings generated from a given number of Best Performing campaigns.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/earnings`

Request

Parameter	Required	Data type	Notes
`limit`	Yes	`int`	The number of campaigns to return.
`date_from`	Yes	`string`	The date to get earnings metrics from. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	The date to get earnings metrics up to. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/earnings?limit=2&date_from=2022-01-01T10:10:10Z&date_to=2022-12-01T10:10:10Z \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "value": 123.00
}

Get Summary

Returns a number of trial affiliate licenses, paid affiliate licenses, and expired affiliate licenses.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/affiliates/summary`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/affiliates/summary \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "trials": 0,
    "paid": 0,
    "expired": 0
}

Solution Partner

Create Organization

Creates a new organization for a client.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/organizations`

Request

Parameter	Required	Data type	Notes
`organization_name`	Yes	`string`	The name of the client's organization.
`client_name`	Yes	`string`	The client's full name.
`client_email`	Yes	`string`	The organization owner email address.
`data_center`	No	`string`	The database location. Possible values: `us-south1` (USA), `eu-west3` (EU).
`identifier`	No	`string`	A custom organization identifier.

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/solutions/organizations \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "organization_name": "ACME Inc.",
    "client_name": "John Doe",
    "client_email": "john@example.com",
    "data_center": "us-south1"
  }'

EXAMPLE RESPONSE

Copied!

{
  "id": "66c29d75-909b-491b-a0bf-49f79f57e3d5"
}

Get Organization Licenses

Returns the organization's licenses.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/organizations/<organization_id>/licenses`

Request

Parameter	Required	Data type	Notes
`<organization_id>`	Yes	`string`	The organization UUID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/organizations/66c29d75-909b-491b-a0bf-49f79f57e3d5/licenses \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "total": 1,
  "limit": 15,
  "results": [
    {
      "organization_id": "66c29d75-909b-491b-a0bf-49f79f57e3d5",
      "organization_name": "Anna's Organizations",
      "client_name": "Anna Nowak",
      "client_email": "anna.nowak@domain.com",
      "arr": 0,
      "licenses": [
        {
          "external_license_id": "104130623",
          "product": "livechat"
        },
        {
          "external_license_id": "HD-123456789",
          "product": "helpdesk"
        },
        {
          "external_license_id": "123abc456def789",
          "product": "chatbot"
        }
      ]
    }
  ]
}

Get Organization Details

Returns the organization details.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/organizations/<organization_id>`

Request

Parameter	Required	Data type	Notes
`<organization_id>`	Yes	`string`	The organization ID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/organizations/66c29d75-909b-491b-a0bf-49f79f57e3d5 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "organization_id": "66c29d75-909b-491b-a0bf-49f79f57e3d5",
  "name": "Dunder Mifflin",
  "data_center": "us-south1",
  "products": [
    {
      "product": "ChatBot"
    },
    {
      "product": "HelpDesk"
    },
    {
      "product": "LiveChat"
    }
  ],
  "created_at": "2025-11-01T08:00:53Z"
}

Create License

Creates a new license inside an organization for a client.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/organizations/<organization_id>/licenses?product=<product>`

Request

Parameter	Required	Data type	Notes
`<organization_id>`	Yes	`string`	The organization ID of this client's organization.
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`client_name`	Yes	`string`	The client's full name (min. 5 characters).
`client_email`	Yes	`string`	The client's email address. Must match the organization owner email.
`payment_origin`	Yes	`string`	Who would manage the subscription. Possible values: `client`, `partner`.
`trial_duration`	Yes	`int`	The number of days of a trial period (min. 14 - default, max. 30).
`coupon_id`	No	`int`	A custom parameter.
`purchase_order`	No	`string`	A custom parameter.

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/solutions/organizations/66c29d75-909b-491b-a0bf-49f79f57e3d5/licenses?product=livechat \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "client_name": "Joe Doe",
    "client_email": "joe@example.com",
    "payment_origin": "partner",
    "trial_duration": 14
  }'

EXAMPLE RESPONSE

Copied!

{
  "license": "104130623",
  "product": "livechat",
  "creation_timestamp": "2020-02-11 13:18:53",
  "end_timestamp": "2020-02-25 13:18:53",
  "client_name": "Joe Doe",
  "client_email": "joe@example.com",
  "cc_added": false,
  "paid": false,
  "payment_origin": "partner",
  "status": "trial"
}

Get Solution Licenses

Returns the list of licenses.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses`

Request

Parameter	Required	Data type	Notes
`date_from`	No	`string`	Get a report for licenses created from a given date. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	No	`string`	Get a report for licenses created up to a given date. Date format: `YYYY-MM-DDTHH:mm:ssZ`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "license": "104130623",
      "product": "livechat",
      "client_name": "Joe Doe",
      "client_email": "joe@example.com",
      "creation_timestamp": "2023-02-14 12:39:40",
      "end_timestamp": "2023-06-14 12:39:40",
      "cc_added": false,
      "paid": false,
      "payment_origin": "partner",
      "status": "trial"
    },
    {
      "license": "789",
      "product": "chatbot",
      "client_name": "John Doe",
      "client_email": "john@example.com",
      "creation_timestamp": "2023-05-21 07:39:11",
      "end_timestamp": "2024-05-21 07:39:11",
      "cc_added": true,
      "paid": true,
      "payment_origin": "client",
      "status": "paid"
    }
  ]
}

Get Solution Licenses by Status

Returns the list of licenses by status.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<status>`

Request

Parameter	Required	Data type	Notes
`<status>`	Yes	`string`	The license status. Possible values: `paid`, `trial`, `expired`.
`date_from`	Yes	`string`	Get a report for licenses created from a given date. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	Get a report for licenses created up to a given date. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`limit`	No	`int`	The amount of licenses in response (min: 1, max: 15, default: 15).
`next_cursor`	No	`string`	A next page token received from the previous request's response.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/paid?date_from=2022-09-01&date_to=2023-08-31 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "results": [
    {
      "license_id": "104130623",
      "status": "paid",
      "product": "livechat",
      "client_name": "Joe Doe",
      "client_email": "joe@example.com",
      "payment_origin": "partner",
      "creation_timestamp": "2023-02-14 12:39:40",
      "conversion_timestamp": "2023-03-01 07:51:11",
      "expiration_timestamp": "2023-03-14 11:19:25"
    },
    {
      "license_id": "104130345",
      "status": "paid",
      "product": "chatbot",
      "client_name": "Joe Doe",
      "client_email": "joe@example.com",
      "payment_origin": "client",
      "creation_timestamp": "2022-03-29 17:11:43",
      "conversion_timestamp": "2022-04-11 05:10:00",
      "expiration_timestamp": "2023-04-11 05:10:00"
    }
  ],
  "next_cursor": "MDAwMS0wMS0wMSAwMDowMDowMA=="
}

Get License Details

Returns the license details.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "license": "104130623",
  "client_name": "Joe Doe",
  "client_email": "joe@example.com",
  "purchase_order": "Test license",
  "payment_origin": "partner",
  "creation_timestamp": "2018-03-06 12:59:13",
  "end_timestamp": "2018-04-05 11:59:12",
  "conversations": 0,
  "conversations_last_30_days": 0,
  "cc_added": false,
  "paid": false,
  "ql": false,
  "seats": 100,
  "plan": "team",
  "billing_cycle": "monthly",
  "total_discount": 0,
  "discount_percent": 20,
  "total_commission": 0,
  "commission_percent": 0,
  "data_center": "dal",
  "status": "expired",
  "invited_agents": [
    {
      "email": "jane@example.com"
    }
  ]
}

Update License Details

Updates the license details.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`client_name`	Yes	`string`	The client's full name (min. 5 characters).
`purchase_order`	No	`string`	A custom parameter.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request PUT \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --data 'client_name=Jane Doe'

Invite License Operators

Invites operators to a license.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>/operators`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`operators`	Yes	`object[]`	The list of users you want to invite to the license.
`operators.email`	Yes	`string`	The user email.
`operators.role`	Yes	`string`	The user role. Possible values: `administrator`, `agent` (all products), `viewer` (only for `helpdesk`).

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url 'https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623/operators' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --data '{
    "operators": [
      {
        "email": "joe@example.com",
        "role": "agent"
      },
      {
        "email": "jane@example.com",
        "role": "administrator"
      }
    ]
  }'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "operator": "joe@example.com",
      "status_code": 200
    },
    {
      "operator": "jane@example.com",
      "status_code": 400
    }
  ]
}

Get License's Invoices

Returns invoices for a given license.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<license_id>/invoices`

Request

Parameter	Required	Data type	Notes
`<license_id>`	Yes	`string`	The license ID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/104130623/invoices \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "invoice_no": 123,
      "date": "2018-03-03 09:38:33",
      "plan": "team",
      "seats": 10,
      "billing_cycle": "monthly",
      "amount": 312,
      "status": "paid"
    },
    {
      "invoice_no": 122,
      "date": "2018-02-01 09:18:13",
      "plan": "team",
      "seats": 10,
      "billing_cycle": "monthly",
      "amount": 312,
      "status": "paid"
    }
  ]
}

Get License's Invoice PDF

Returns a PDF invoice.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<license_id>/invoices/<invoice_no>`

Request

Parameter	Required	Data type	Notes
`<license_id>`	Yes	`string`	The license ID.
`<invoice_no>`	Yes	`string`	The invoice number.

Response

PDF file (Content-Type: application/pdf).

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/104130623/invoices/123 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

Create Subscription

Creates a new subscription for a license.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>/subscription`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`token`	Yes	`string`	The Recurly token. Get it here.
`plan`	Yes	`string`	The sales plan. Possible values: `starter`, `team`, `business`.
`billing_cycle`	Yes	`string`	The billing cycle. Possible values: `monthly`, `annual`.
`seats`	Yes	`int`	The number of users.

Response

No response payload (201 Created).

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623/subscription \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "C12ibIjbXbqSAhKjxQWERTY",
    "plan": "team",
    "billing_cycle": "monthly",
    "seats": 5
  }'

Update Subscription

Updates a subscription for a license.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>/subscription`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`plan`	Yes	`string`	The sales plan. Possible values: `starter`, `team`, `business`.
`billing_cycle`	Yes	`string`	The billing cycle. Possible values: `monthly`, `annual`.
`seats`	Yes	`int`	The number of users.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request PUT \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623/subscription \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "plan": "business",
    "billing_cycle": "annual",
    "seats": 10
  }'

Close Subscription

Closes a subscription for a license.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>/subscription`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`password`	Yes	`string`	Your password in Partner Program.
`expire`	No	`bool`	If `true`: the license expires immediately. If `false` (default): the license expires at the end of its billing cycle.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request DELETE \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623/subscription \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "password": "your_password",
    "expire": false
  }'

Update License Billing

Updates the subscription billing information for a license.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>/billing`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`token`	Yes	`string`	The Recurly token. Get it here.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request PUT \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623/billing \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "C12ibIjbXbqSAhKjxQWERTY"
  }'

Transfer License

Transfers a license to the client.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/<product>/<license_id>/transfer`

Request

Parameter	Required	Data type	Notes
`<product>`	Yes	`string`	The product. Possible values: `livechat`, `chatbot`, `helpdesk`.
`<license_id>`	Yes	`string`	The license ID.
`new_owner`	Yes	`string`	The new owner's email (one of existing operators).

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/104130623/transfer \
  --data 'new_owner=joe@doe.com' \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "license": "987",
  "client_name": "Joe Doe",
  "client_email": "joe@example.com",
  "purchase_order": "Test license",
  "payment_origin": "client",
  "creation_timestamp": "2018-03-06 12:59:13",
  "end_timestamp": "2019-04-05 11:59:12",
  "conversations": 0,
  "conversations_last_30_days": 0,
  "cc_added": false,
  "paid": true,
  "recurrent": false,
  "seats": 100,
  "plan": "team",
  "billing_cycle": "monthly",
  "total_discount": 4148,
  "discount_percent": 20,
  "total_commission": 0,
  "commission_percent": 0,
  "expired": false,
  "blocked": false,
  "data_center": "dal"
}

Get Recurly Token

Returns the token from Recurly. The token is required when creating a new subscription or updating an existing one with the new billing info.

Specifics


Method URL	`https://api.recurly.com/js/v1/token`

Request

Parameter	Required	Data type	Notes
`key`	Yes	`string`	The public key: `ewr1-QCXZap10wOSm13fxI4u5Jt`.
`first_name`	Yes	`string`	The first name.
`last_name`	Yes	`string`	The last name.
`number`	Yes	`string`	The credit card number.
`month`	Yes	`string`	The credit card expiration month. Format: `MM`.
`year`	Yes	`string`	The credit card expiration year. Format: `YYYY`.
`verification_value`	Yes	`string`	The CVV code.
`address1`	Yes	`string`	The address.
`city`	Yes	`string`	The city.
`state`	Yes	`string`	The state.
`zip`	Yes	`string`	The ZIP/Postal code.
`country`	Yes	`string`	The country code, one of these.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url 'https://api.recurly.com/js/v1/token?key=ewr1-QCXZap10wOSm13fxI4u5Jt&first_name=John&last_name=Doe&number=4111111111111111&month=12&year=2025&verification_value=123&address1=123%20Main%20St&city=New%20York&state=NY&zip=10001&country=US'

EXAMPLE RESPONSE

Copied!

{
  "id": "C12ibIjbXbqSAhKjxQWERTY"
}

Get License Metrics

Returns the number of trials, paid licenses, and expired licenses from the Solution program.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/count`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	Get trials metrics from a given date. Date format: `YYYY-MM-DD`.
`date_to`	Yes	`string`	Get trials metrics up to a given date. Date format: `YYYY-MM-DD`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/licenses/count?date_from=2022-09-01&date_to=2023-08-31 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "trials": 150,
    "paid": 16,
    "expired": 147
}

Get Solution Licenses Report

Returns a report for licenses by license status.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/reports/license`

Request

Parameter	Required	Data type	Notes
`date_from`	Yes	`string`	Get report from a given date. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`date_to`	Yes	`string`	Get report up to a given date. Date format: `YYYY-MM-DDTHH:mm:ssZ`.
`aggregation`	Yes	`string`	Get report aggregated by a given timespan. Possible values: `day`, `week`, `month`.
`license_status`	Yes	`string`	Get report for a given licenses status. Possible values: `trial`, `paid`, `expired`.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/reports/license?date_from=2023-03-25T00:00:00Z&date_to=2023-03-26T23:59:59Z&aggregation=month&license_status=trial \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "items": [
        {
            "date_range": {
                "from": "2022-03-01 00:00:00",
                "to": "2022-03-31 23:59:59"
            },
            "total": 12
        },
        {
            "date_range": {
                "from": "2022-04-01 00:00:00",
                "to": "2022-04-30 23:59:59"
            },
            "total": 34
        },
        {
            "date_range": {
                "from": "2022-05-01 00:00:00",
                "to": "2022-05-31 23:59:59"
            },
            "total": 56
        }
    ]
}

Get Solution Licenses CSV Report

Returns a CSV report for licenses.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/licenses/search/csv`

Request

Parameter	Required	Data type	Notes
`filters`¹	No	`string`	Apply filters to narrow down the results. URL-encoded array of objects.

1) filters object structure:

field - field name. Possible values: license_product, license_status, license_details, license_created_at, payment_origin, credit_card.
operator - comparison operator. Possible values: equals, contains, exists, greater_or_equal, lesser_or_equal.
value - field value.

Example filter: filters=[{"field": "license_product", "operator": "equals", "value": "LiveChat"}, {"field": "credit_card", "operator": "exists", "value": "no"}]

Response

Returns the data in CSV format.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url 'https://api.livechatinc.com/v2/partners/solutions/licenses/search/csv?filters=%5B%7B%22field%22%3A%22credit_card%22%2C%22value%22%3A%22no%22%2C%22operator%22%3A%22exists%22%7D%5D' \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

License ID,Managed by,Status,Client name,Client email,Client identifier,Created,Product,Credit card,Card problem,Commission level,Discount level,Total earnings,Total savings
ExampleLicenseID,partner,trial,Client Name,client@test.com,client-identifier,2024-01-22 08:53:53,HelpDesk,no,,0.00,20.00,0.00,0.00

Get Leads

Returns partner leads.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/leads`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/leads \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "result": [
        {
            "lead_id": "123",
            "company_name": "company-123",
            "contact_email": "company-123@test.com",
            "status": "new"
        },
        {
            "lead_id": "456",
            "company_name": "company-456",
            "contact_email": "company-456@test.com",
            "status": "new"
        }
    ]
}

Get Lead Details

Returns lead details.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/leads/<lead_id>`

Request

Parameter	Required	Data type	Notes
`<lead_id>`	Yes	`string`	The lead ID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/leads/123 \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "partner_id": "partner-id-123",
    "external_lead_id": "123",
    "status": "new",
    "fee_amount": 0,
    "company_name": "lead-company-name",
    "contact_email": "contact@test.com",
    "domain": "www.company-test-123.com",
    "first_name": "name",
    "last_name": "last name",
    "region": "USA",
    "job_title": "job title",
    "phone_number": "123 456 789",
    "description": "",
    "updated_at": "2023-10-02 15:44:59"
}

Get Lead History

Returns lead history.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/leads/<lead_id>/history`

Request

Parameter	Required	Data type	Notes
`<lead_id>`	Yes	`string`	The lead ID.

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/leads/54321/history \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "result": [
        {
            "name": "lead_was_created",
            "created_at": "2023-09-18 11:17:35"
        }
    ]
}

Submit Lead

Submits a lead.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/leads`

Request

Parameter	Required	Data type	Notes
`partner_name`	Yes	`string`	The partner name.
`partner_email`	Yes	`string`	The partner email.
`company_name`	Yes	`string`	The lead company name.
`contact_email`	Yes	`string`	The lead contact email.
`domain`	Yes	`string`	The domain.
`first_name`	Yes	`string`	The first name.
`last_name`	Yes	`string`	The last name.
`region`	No	`string`	The lead region (country code).
`job_title`	No	`string`	The job title.
`phone_number`	No	`string`	The phone number.
`description`	No	`string`	The description.
`sends_personal_introduction`	No	`bool`	Set to `true` to send personal introduction.
`is_included_in_communication`	No	`bool`	Set to `true` to be included in communication.
`accepts_requirements`	Yes	`bool`	Set to `true` to accept requirements.
`monetization_type`	Yes	`string`	Possible values: `flat_fee`, `rev_share`. Check the difference here.

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/solutions/leads \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "partner_name": "John Doe",
    "partner_email": "john@partner.com",
    "company_name": "ACME Inc.",
    "contact_email": "contact@acme.com",
    "domain": "www.acme.com",
    "first_name": "Jane",
    "last_name": "Smith",
    "accepts_requirements": true,
    "monetization_type": "flat_fee"
  }'

EXAMPLE RESPONSE

Copied!

{
    "lead_id": "123"
}

Get Solution Summary

Returns a summary from the Solution Program.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/solutions/summary`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/solutions/summary \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
    "trials": "12",
    "paid": "14",
    "expired": "13",
    "commission": "12.33",
    "discount": "34.11"
}

Partner Directory

Upload Logo

Uploads the Expert logo.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/profile/logo`

Request

The request body should contain a .jpg or .png image, min. 350x350px, max. 1000x1000px.

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/experts/profile/logo \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: image/png' \
  --data-binary '@logo.png'

EXAMPLE RESPONSE

Copied!

{
  "result": "https://cdn.example.com/expert-logo.png"
}

Create Expert Profile

Creates the Expert profile.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/profile`

Request

Parameter	Required	Data type	Notes
`company`	Yes	`string`	The company name (min. 4 characters).
`phone`	Yes	`string`	The phone number.
`description`	Yes	`string`	The description displayed in the profile details (min. 10 characters).
`short_description`	Yes	`string`	The description displayed in the Expert tile (min. 10 characters).
`country`	Yes	`string`	The country code, one of these.
`website`	Yes	`string`	The website URL.
`categories`	Yes	`string[]`	An array of categories¹.
`industry_ids`	Yes	`int[]`	Industry specializations².
`projects`	Yes	`string[]`	An array of projects (URLs).
`agents`	No	`string`	The number of agents (required if category is `outsourcing-customer-service`). Possible values: `1-5`, `6-15`, `16-30`, `31-50`, `51+`.
`languages`	No	`string[]`	An array of language codes (required if category is `outsourcing-customer-service`). Available languages.
`hour_rate`	No	`int`	The minimum hourly rate.
`project_rate`	No	`int`	The minimum project rate.
`facebook`	No	`string`	The URL to the Facebook page.
`twitter`	No	`string`	The URL to the Twitter page.
`linkedin`	No	`string`	The URL to the LinkedIn page.

1) Possible values for categories:

chat-agent-outsourcing
custom-development
product-implementation
chatbot-building
training

2) Possible values for industry_ids:

1 - Banks
4 - Financial Services
7 - Government
10 - Healthcare
13 - Education & Universities
16 - Telecommunications
19 - Technology
22 - Media & Entertainment
25 - Travelling
28 - Charities, Foundations & Non-Profits
31 - E-commerce
34 - Medical & Wellness
37 - Hospitality
40 - Real Estate
43 - Automotive
46 - Professional Services
49 - Other

Response

No response payload (201 Created).

EXAMPLE REQUEST

Copied!

curl --request POST \
  --url https://api.livechatinc.com/v2/partners/experts/profile \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "company": "ACME",
    "phone": "123456789",
    "description": "Long description goes here",
    "short_description": "Short description",
    "country": "US",
    "website": "https://partners.livechatinc.com",
    "categories": ["api-and-integrations"],
    "industry_ids": [19, 22],
    "projects": ["https://example.com"]
  }'

Get Expert Profile

Returns the Expert profile details.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/profile`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/experts/profile \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "expert_id": "expert-example",
  "partner_id": "BC-SAMPLE123",
  "status": "verified",
  "company": "ACME",
  "phone": "123456789",
  "logo": "https://cdn.example.com/expert-logo.png",
  "description": "Long description goes here",
  "short_description": "Short description (visible in Marketplace tile)",
  "agents": "5+",
  "hour_rate": 50,
  "project_rate": 500,
  "country": "US",
  "website": "https://partners.livechatinc.com",
  "twitter": "https://twitter/LiveChatProgram",
  "categories": [
    "api-and-integrations",
    "chat-strategy-consultancy"
  ],
  "languages": [
    "EN",
    "ES"
  ],
  "projects": [
    "https://example.com"
  ],
  "industry_ids": [
    19,
    22,
    25,
    28
  ]
}

Update Expert Profile

Updates the Expert profile details.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/profile`

Request

See Create Expert Profile for parameter details.

Response

No response payload (204 No Content).

EXAMPLE REQUEST

Copied!

curl --request PUT \
  --url https://api.livechatinc.com/v2/partners/experts/profile \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "company": "ACME Updated",
    "phone": "987654321",
    "description": "Updated long description",
    "short_description": "Updated short description",
    "country": "US",
    "website": "https://partners.livechatinc.com",
    "categories": ["custom-development"],
    "industry_ids": [19],
    "projects": ["https://example.com"]
  }'

Get Comments

Returns comments on the Expert profile.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/comments`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/experts/comments \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "comment": "This Expert provides a valuable tool to any online business. Very impressed with the speed at which chats are answered and the professional yet personal touch with which they approach each chat.",
      "author": "Joe",
      "creation_timestamp": "2018-03-06 10:21:50",
      "website": "https://example.com"
    },
    {
      "comment": "Great company and great people. They have helped train the team and get the most out of the chat system. Inbounds have increased and process has improved. The product itself is very easy to use. A brilliant service end to end.",
      "author": "Jane",
      "creation_timestamp": "2018-02-22 13:32:28",
      "website": ""
    }
  ]
}

Get Expert Stats

Returns stats (Experts Marketplace position, number of comments and messages) for the Expert profile.

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/stats`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/experts/stats \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "position": 1,
  "comments": 18,
  "messages": 132
}

Get Expert History

Returns historical stats for the Expert profile views (up to last 12 months).

Specifics


Method URL	`https://api.livechatinc.com/v2/partners/experts/history`

EXAMPLE REQUEST

Copied!

curl --request GET \
  --url https://api.livechatinc.com/v2/partners/experts/history \
  --header 'Authorization: Bearer <YOUR_API_TOKEN>'

EXAMPLE RESPONSE

Copied!

{
  "result": [
    {
      "date": "2018-03",
      "profile_views": 123
    },
    {
      "date": "2018-02",
      "profile_views": 212
    },
    {
      "date": "2018-01",
      "profile_views": 286
    }
  ]
}

Response errors

This section describes the error responses that can be returned by the Partner API.

Status code	Error type	Description
`400`	Bad request	The request contains missing or incorrect parameters.
`401`	Unauthorized	The authorization header is missing or incorrect.
`403`	Forbidden	The authenticated partner lacks permission to access the requested resource or perform the action.
`404`	Not found	The requested resource does not exist or is not accessible.
`409`	Conflict	The request conflicts with the current state of the resource. The resource may already exist or cannot be found.

Contact us

If you found a bug or a typo, you can let us know directly on GitHub. For questions or feedback, contact us at developers@text.com.

Partner API.css-1g0dr3m{margin-top:8px;}.css-1g0dr3m > label{margin:0 0 5px 0;}.css-1g0dr3m label + div{-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;}

API status

Authorization

Available methods

Postman Collection

Account

Get Profile

Specifics

Update Profile

Specifics

Request

Response

Get Stats

Specifics

Get Coupons

Specifics

Get Earnings

Specifics

Get Commission Report

Specifics

Request

Get Partners Referred Earnings Report

Specifics

Request

Get Billing

Specifics

Get Balance

Specifics

Get Commission Metric

Specifics

Request

Update Billing

Specifics

Request

Response

Request Withdrawal

Specifics

Get Withdrawals

Specifics

Request

Create API Token

Specifics

Request

Get API Tokens

Specifics

Revoke API Token

Specifics

Request

Response

Affiliate Partner

Create Campaign

Specifics

Request

Search Campaigns

Specifics

Request

Get Campaigns

Specifics

Request

Disable Campaign

Specifics

Request

Response

Get Affiliate Licenses

Specifics

Request

Get Performance Report

Specifics

Request

Get Partners Referred

Specifics

Get Affiliate Links

Specifics

Get Trials Metrics

Specifics

Request

Get Earnings Metrics

Specifics

Request

Get Conversions Metrics

Partner API