Create a Lead via API

Use the endpoints to emulate sending traffic or Lead registration via API integration.

Request example

URL, method: POST https://integration.{brand name}.clixnow.com/api/system/v1/leads

Header: Authorization: ApiToken {unique API Token provided to the Affiliate}

Content-Type: application/json

Example Request:

curl --location --globoff 'https://integration.{brand name}.clixnow.com/api/system/v1/leads' \
--header 'Content-Type: application/json' \
--header 'Authorization: ApiToken {unique API Token provided to the Affiliate}' \
--data '{BODY_DATA}'

Body:

Copy the body example below the CURL request instead of {BODY_DATA} placeholder.

{
   "firstName":"Allison",
   "lastName":"Brown",
   "email":"[email protected]",
   "phone":"+41123456789",
   "countryCode":"CH",
   "referralUrl":"https://website.com",
   "subcampaign":"subcampaign",
   "keyword":"test",
   "placement":"landing_page",
   "clickId":"20fn4ngo56n3snf74",
   "ipAddress":"1.1.1.1",
   "languageCode":"EN",
   "password":"Password123!",
   "sub2":"sub2",
   "deviceType":"Mobile",
   "deviceName":"iPhone16",
   "osName":"iOS",
   "browser":"Safari Mobile",
   "carrier":"Mobile"
}

Parameters

Name	Type	Mandatory	Description
`firstName`	`string`	Yes	Lead’s first name
`lastName`	`string`	Yes	Lead’s last name
`email`	`string`	Yes	Lead’s email address
`phone`	`string`	Yes	Lead’s phone number
`Password`	`string`	Yes	Lead’s password, a special character is required, min number of required characters is eight
`countryCode`	`string`	Yes	Alpha-2 country code
`languageCode`	`string`	No*	Alpha-2 country code *If Language Detection – Registration Language, then field is mandatory
`acceptTermsAndConditions`	`boolean`	No	By default: false
`acceptPromotions`	`boolean`	No	By default: false
`referralUrl`	`string`	No	URL of the landing page. URL Example

`subCampaign`	`string`	No	Identify sources or marketing campaigns. Can be sent in postback
`placement`	`string`	No	Name of the landing page or ad. Can be sent in postback
`keyword`	`string`	No	Keyword name. Can be sent in postback
`sub2`	`string`	No	Extra free sub value. Can be sent in postback
`clickId`	`string`	No	Can be sent in postback
`deviceType`	`string`	No	Device type
`deviceName`	`string`	No	Device name
`osName`	`string`	No	Operational system of the device
`browser`	`string`	No	Browser on the device
`carrier`	`string`	No	Possible values: Mobile, WiFi
`ipAddress`	`string`	No	IPv4 or IPv6
`comment`	`string`	No	Any text comment, up to 1000 characters

Landing page URL Example

https://landing.com/?a_id={Affiliate ID}\&c_id={Landing page ID}\&f_id={Related Funnel ID}\&subcampaign=subcampaign\&sub2=sub_name\&keyword=test\&clickid=1c33d66a941ac90a6\&placement=test

Response

The 200 OK response for the registered Lead will return:

{
"leadId": 123456,
"redirectUrl": "https:…",
"subCampaign": "subcampaign",
"placement": "placement",
"keyword": "keyword",
"sub2": "sub2",
"clickId": "clickId",
"crmId": "crmId"
}

Request and Response

An object that contains an error will be returned when API request fails. Error codes:

Status	Description
`200 OK`	General success status code
`201 Created`	Item was created successfully via POST
`400 Bad Request`	General error when fulfilling the request would cause an invalid state. Domain validation errors, missing data, etc.
`401 Unauthorized`	Error code response for missing or invalid authentication token
`403 Forbidden`	Error code for when the user is not authorized to perform the operation, or certain item is unavailable for some reason.
`415 Unsupported Media Type`	Wrong Accept/Content-Type

Monitoring data

URL, method: GET https://integration.{brand name}.clixnow.com/api/system/v1/leads/search?

Header: Authorization: ApiToken {personal API Token}

Example Request:

curl --location --globoff 'https://integration.{brand name}.clixnow.com/api/system/v1/leads/search?createdOnFrom=2021-08-08T00%3A00%3A00&createdOnTo=2021-08-08T23%3A59%3A59'\
--header 'Authorization: ApiToken {YourApiToken}'

Use the parameters below to retrieve the necessary data:

Name	Type	Description
`orderBy`	`string`	Ability to sort ascendingly the returned Leads by: ModifiedOn, CreatedOn, FtdFate, Id – please make sure that the first letter in the name of the parameter is big. For now there is no ability to sort descendingly;
`id`	`integer`	Ability to get Lead details by lead Id in Clixnow
`count`	`integer`	Paging parameter - number of Leads to fetch; defaults to 10; !max number of records per request is 1000!
`skip`	`integer`	Paging parameter - number of Leads to skip from the beginning of list or from the previous group of fetched records; defaults to 0
`modifiedOnFrom`	`string (date-time)`	Start date of the date range to filter by update date and time (in UTC)
`modifiedOnTo`	`string (date-time)`	End date of the date range to filter by update date and time (in UTC)
`createdOnFrom`	`string (date-time)`	Start date of the date range to filter by creation date and time (in UTC)
`createdOnTo`	`string (date-time)`	End date of the date range to filter by creation date and time (in UTC)
`ftdDateTo`	`string (date-time)`	Start date of the date range to filter by FTD date and time (in UTC)
`ftdDateFrom`	`string (date-time)`	End date of the date range to filter by FTD date and time (in UTC)

Response model

Name	Type	Description
`id`	`integer`	ID of the Lead within Clixnow
`email`	`string`	Lead email, that value is sent over registration request
`status`	`string`	Lead status
`crmId`	`integer`	ID of the Lead in Brand CRM that accepted the Lead. Visibility is controlled per Affiliate via Admin UI.
`brandId`	`integer`	ID of the Brand in Clixnow; brand which accepted the Lead. Visibility is controlled per Affiliate via Admin UI.
`brandName`	`string`	Name of the Brand in Clixnow; brand which accepted the Lead
`createdOn`	`string (date-time)`	Date when the Lead was updated in UTC, ex. 2022-12-19T11:01:58.302Z
`updatedOn`	`string (date-time)`	Date when the Lead was updated in UTC, ex. 2022-12-19T11:01:58.302Z
`ftdDate`	`string (date-time)`	Returns FTD date if such was made. Visibility is controlled per Affiliate via Admin UI.
`clickId`	`integer`	The value that was sent in registration request
`sub2`	`string`	The value that was sent in registration request
`subCampaign`	`string`	The value that was sent in registration request
`keyword`	`string`	The value that was sent in registration request
`placement`	`string`	The value that was sent in registration request
`clientType`	`string`	Can be Client (when FTD was made) or Depositor (when FTD was not made)

Pagination:

By default, the response includes 10 records. To retrieve more, use the count parameter (e.g., count=1000). If there are over 1000 records, use the ‘skip’ parameter to fetch subsequent batches.

Example:

https://integration.{brand name}.clixnow.com/api/system/v1/leads/search?createdOnFrom=2021-08-08T00:00:00&createdOnTo=2021-08-08T23:59:59&count=1000&skip=0

**Additional Filters:
**You can also filter by ‘modifiedOn’ or ‘ftdDate’ using similar date and time formats. Specify the required parameter in the query.

Errors

Text Description automatically generated

Shape, rectangle Description automatically generated

Integrations

Platforms

Cellxpert
DR Tracker
Elnopy
GetLinked
IREV
LeadGreed
Leverate
PlatformsFX
TrackBox

Clixnow affiliate admin panel manual

Getting started

Authorization

Affiliates can log in to their admin panel with the email-password pair, provided by the affiliate’s manager. The password and personal affiliate data can be changed later. See Account management for more information.

User Interface

Upon logging into their account, affiliates will see the inteface with the following main sections:

Affiliate name and email with the access to My Account settings.
Commission amount accrued by the affiliate in the current month. The amount gets reset on the first day of the new month.

Dashboard. Shown by default upon logging in. Here affiliates can analyze their lead traffic statistics in depth with the intuitive infographics.
Marketing tools* with all the marketing funnel information handy, with easy access to affiliate links.
Commission with the detailed information on how much the affiliate earned.
Reports, where affiliates can form and export customized reports with detailed lead information.

Account management

To access affiliate account settings, click on affiliate profile at the top left and select Account in the expanded menu.

On My account page, affiliates can:

Edit their first and last name on the Personal Info tab.
Change their password on the Password tab.

Dashboard

On the Dashboard, affiliates can review general account statistics, presented as card-based infographics.

The following cards are available on the dashboard.

Affiliate performance card – shows common metrics such as conversion rate, conversions and registrations. Below affiliates can see the growth dynamic in comparison with the previous period.
Conversion rate. The card displays lead conversion data as a line graph, making it possible to view all data from the Affiliate performance card in relation to the selected timeframe. Use the dropdown menu near the title to select the metric you need to see visualized like that on this card.
Registrations per brand/Conversions per brand card is displayed in a pie chart view and shows the share of each brand for a specific indicator in the general statistics. Each color represents a different brand. The five brands with the highest number of conversions/registrations are shown, while the others are grouped under the "other" sector. Click the Expand button to view a more detailed pie chart.
Registrations per country/Conversions per country card. Affiliates can view statistics on registrations/conversions across different countries. Click the Expand button to see a more detailed bar chart.
Failed registration reasons card. Affiliates can view statistics on the reasons for failed registration attempts. The four reasons that are connected to the biggest number of fails displayed on the diagram, whereas the rest are united under the other group. Click the Expand button to see a more detailed bar chart.

To customize the cards displayed on the dashboard, click Customize Dashboard at the top right and select the cards in the window that appears.

To filter the data displayed on the dashboard by country or timeframe, use the tools above the cards grid.

To quickly access detailed data, click View full report at the bottom of the relevant cards.

Marketing Tools

The Marketing Tools tab shows all the funnels registered to the affiliate's account.

A funnel is the process a lead goes through, starting from first seeing an ad to becoming a paying client.

Marketing funnels refer to the materials affiliates use to drive lead traffic throughout this process.

In Marketing Tools, affiliates can:

View the funnels, sort and filter them, toggle detailed funnel view by using the tools at the top of the funnel grid.
Access individual funnel details and generate an affiliate link on the Funnel card.
See funnels with the best performance by selecting Top Funnels tab at the top of the grid.
Display the funnels in the list view on Registered funnels tab.

Funnel Card

To access the Funnel card, click on it in the New Funnels or Top Funnels grid.

In the individual Funnel card, affiliates can:

Check detailed Funnel info and upload Funnel preview image on Funnel details section.
See how leads interact with Funnel’s creative materials on Creative performance section.
Generate affiliate link for the Funnel on Links section.
Preview Funnel Creative materials on Funnel Creatives.

Registered Funnels

Funnels are considered registered if a link was generated for them at least once, either by the affiliate or on their behalf.

Registered Funnels tab represents the Funnel data in list view, with the following sorting and filtering tools:

Created date supports the calendar. It means that affiliates can set the timeframe and filter the data by this parameter.
Brand support multiple selection. Affiliates can select several items from the drop-down list.
Funnel type, Category and Subcategory support single selection. Affiliates can select only one value to be shown at once.
Funnel name supports the search bar.

Affiliates can copy a pre-generated link for the funnel by clicking Copy link to the right of the Funnel entry.

Commission

In the Commission section, affiliates can see all the Bundles, Deals and Settlement data associated with their account. They can filter the data by Bundle ID and Description using the tools above the Bundle list.

To see the Bundle details, select it from the list. The Bundle info will be displayed to the right of the Bundles list.

To see the details for each deal or settlement within the Bundle, click on its title to expand it.

Reports

The Reports tab gives affiliates detailed information about their leads.

The Reports grid displays a list of leads along with detailed information, such as lead ID, creation date, affiliate, country, brand, and more.

Affiliates can filter and sort the data on the reports grid with the tools described below:

Created date, FTD date, CPL date and CPA date supports the calendar. It means that affiliates can set the timeframe and filter the data by this parameter.
Affiliate, Country and Brand support multiple selection. Affiliates can select several items from the drop-down list.
Client type support single selection. Affiliates can select only one value to be shown at once.
Other filtering tools are used with the search bar.

The buttons above the report list have the following functionality:

Reset filters button deletes all the filters that were set before.
Refresh data button refreshes the leads table but keeps the selected filters.
Export button export data from the leads table in CSV format with the selected filters.
Table view button opens the menu where the Affiliate can select only the relevant parameters to configure the data displayed on the report and toggle whether failed/successful registrations are displayed.