Skip to main content

Microconversions Endpoint

Updated this week

Overview

The Microconversions endpoint provides detailed analytics about microconversion events on your website. Microconversions are small engagement actions that users take before completing a primary conversion, such as adding items to cart, viewing product details, or signing up for newsletters.

Endpoint Details

- Method: GET

- Authentication: Bearer Token required

Request Parameters

Headers

Header

Value

Required

Authorization

Bearer {your_access_token}

Yes

Accept

application/json

Yes

Connection

keep-alive

Recommended

Accept-Encoding

gzip, deflate, br

Recommended

Query Parameters

Parameter

Type

Required

Description

account_id

string

Yes

Your account identifier

date_range

string

Yes

Date range for the data (format: YYYYMMDD,YYYYMMDD or predefined values like `this_month`)

skip

No

No

Number of records to skip (for pagination), defaults to 0

limit

No

No

Maximum number of records to return, defaults to 100 with max value of 100

country

string

No

ISO 3166-1 alpha-2 country code filter (e.g., "es" for Spain

Example Request

cURL

```bash

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImp0aSI:ImpoaS1Nzg5MzQzIn0...' \

--header 'Accept: application/json' \

--header 'Connection: keep-alive' \

--header 'Accept-Encoding: gzip, deflate, br'

```

Python

```python

import requests

querystring = {

"account_id": "000000000000000000001234",

"date_range": "this_month",

"skip": "0",

"limit": "100"

}

headers = {

"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImp0aSI:ImpoaS1Nzg5MzQzIn0...",

"Accept": "application/json",

"Connection": "keep-alive",

"Accept-Encoding": "gzip, deflate, br"

}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

```

JavaScript

```javascript

var myHeaders = new Headers();

myHeaders.append("Authorization", "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImp0aSI:ImpoaS1Nzg5MzQzIn0...");

myHeaders.append("Accept", "application/json");

myHeaders.append("Connection", "keep-alive");

myHeaders.append("Accept-Encoding", "gzip, deflate, br");

var requestOptions = {

method: 'GET',

headers: myHeaders,

redirect: 'follow'

};

.then(response => response.text())

.then(result => console.log(result))

.catch(error => console.log('error', error));

```

Response

Success Response (200 OK)

```json

{

"status": "ok",

"data": [

{

"_id": "67eaca8cadeb4e04b13d7df4",

"date": "2025-03-31",

"utm_matchtype": null,

"utm_campaign": "seo-yahoo",

"utm_source": "seo",

"utm_medium": "organic",

"label": "add-to-cart"

},

{

"_id": "67eaca7fba8c162635776cb1",

"date": "2025-03-31",

"utm_matchtype": null,

"utm_campaign": "newsletter",

"utm_source": "newsletter",

"utm_medium": "email",

"label": "newsletter-signup"

}

// Additional results...

]

}

```

Response Parameters

The response data array contains objects with the following fields:

Field

Type

Description

_id

string

Unique identifier for the microconversion

date

string

Date of the microconversion (YYYY-MM-DD)

utm_medium

string

Medium that drove the microconversion (e.g., email, organic)

utm_source

string

Source that drove the microconversion (e.g., seo, newsletter)

utm_campaign

string

Campaign associated with the microconversion

utm_term

string

Term or URL associated with the microconversion

utm_matchtype

string

Match type for search campaigns (may be null)

label

string

Type of microconversion (e.g., "add-to-cart", "newsletter-signup"

Error Response (401 Unauthorized)

```json

{

"status": "error",

"message": "Unauthenticated"

}

```

Error Response (400 Bad Request)

```json

{

"status": "error",

"message": "Missing required parameter: account_id"

}

```

Notes

- Microconversions are valuable for understanding user engagement before final conversions

- Different microconversion types are identified by the `label` field

- Analyze microconversions alongside main conversions to optimize your conversion funnel

- Use date filtering to track changes in microconversion patterns over time

Did this answer your question?