Getting started

Our technical API documentation can be found in the API reference

To get started building your queries, you can actually use the query builder right inside the documentation.

For a very basic API request, simply follow these steps:

1. Grab the API key and your dataset ID from your (trial) account
2. head over to API reference and find the right endpoint you want to test. In most cases this will be c_view_leads inside the leads group
3. Paste the API key in the API key box
4. paste the dataset ID in the site parameter field
5. Click the Try it Out button
6. You can now preview the data in the Response Body field and grab the code or full API implementation inside your application or workflow

---

Leadscoring parameters

If you want to use the leadscore features build inside our API you can use this documentation to get started.

The LeadBoxer scoring engine can score on 4 criteria

1. Range
2. Match
3. Exist
4. Boost

Range

A range can be used for scoring on number ranges, eg pageviews, visits, etc.

Range needs these 5 values:

1. field name
2. Start of the range
3. End of range
4. Score value
5. Comma (not for last)

Example:

user.total_number_visits.total_number_visits_long|1|5|2.3,user.total_number_visits.total_number_visits_long|5|25|4.7,user.total_number_visits.total_number_visits_long|25|1000|7.0,user.total_pages_viewed.total_pages_viewed_long|1|5|2.3,user.total_pages_viewed.total_pages_viewed_long|5|25|4.7,user.total_pages_viewed.total_pages_viewed_long|25|1000|

Match

Match can be used if you want to score on a exact value match on any field

A match needs 3 values

1. field name
2. Value
3. Score

Example

OrganizationIndustry|Publishing|9|last_country_code|US|9

Exist

Exist can be used to score on the existence of a value

An Exist needs 2 values

1. field name
2. Score

Example

email|3,organizationPhone|10,organizationDomain|15

Boost

Boost can be used for scoring on events/pageviews/etc

A Boost requires 3 values

1. Event type (usually root_url)
2. The actual URL
3. Score

Example

root_url|https://mydomain.com/contact/|7,root_url|https://mydomain.com/buy-your-equipment/|7,root_url|https://mydomain.com/sell-your-equipment/|7