Overview
The Conversions endpoint provides detailed analytics about conversion events on your website. This endpoint allows you to track and analyze sales, sign-ups, or other conversion events across different marketing channels and campaigns.
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 | No | No | ISO 3166-1 alpha-2 country code filter (e.g., "es" for Spain) |
utm_medium | string | No | Filter by medium (e.g., email, cpc, social media) |
utm_source | string | No | Filter by source (e.g., google, facebook, newsletter) |
utm_campaign | string | No | Filter by campaign name |
Example Request
cURL
```bash
curl --location 'https://app.sealmetrics.com/api/report/conversions?date_range=this_month&skip=0&limit=100&account_id=000000000000000000001234' \
--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'
};
fetch("https://app.sealmetrics.com/api/report/conversions?date_range=this_month&skip=0&limit=100&account_id=000000000000000000001234", requestOptions)
.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": "67eacf47086ba659fa2dd471",
"amount": 198.09,
"utm_medium": "email",
"utm_source": "newsletter",
"utm_campaign": "newsletter",
"utm_term": "http://www.rath.org/dolorem-dicta-provident-iusto-quis-ipsam",
"utm_matchtype": null,
"country": "es",
"country_name": "Spain",
"date": "2025-03-31",
"label": "sales"
},
{
"_id": "67eacf4301e86b50b10e87a6",
"amount": 27.24,
"utm_medium": "cpc",
"utm_source": "google",
"utm_campaign": "619999662",
"utm_term": "Gshopping-194682000766",
"utm_matchtype": null,
"country": "es",
"country_name": "Spain",
"date": "2025-03-31",
"label": "sales"
}
// Additional results...
]
}
```
Response Parameters
The response data array contains objects with the following fields:
|
|
|
|
|
|
Field | Type | Description |
_id | string | Unique identifier for the conversion |
amount | number | Monetary value of the conversion |
utm_medium | string | Medium that drove the conversion (e.g., email, cpc) |
utm_source | string | Source that drove the conversion (e.g., google, newsletter) |
utm_campaign | string | Campaign associated with the conversion |
utm_term | string | Term or URL associated with the conversion |
utm_matchtype | string | Match type for search campaigns (may be null) |
country | string | ISO 3166-1 alpha-2 country code |
country_name | string | Full name of the country |
date | string | Date of the conversion (YYYY-MM-DD) |
label | string | Type of conversion (e.g., "sales") |
Error Response (401 Unauthorized)
```json
{
"status": "error",
"message": "Unauthenticated"
}
```
### Error Response (400 Bad Request)
```json
{
"status": "error",
"message": "Missing required parameter: account_id"
}
```
Notes
- This endpoint provides detailed information about individual conversion events
- Use the filtering parameters to analyze conversions from specific marketing channels or campaigns
- The response includes both the country code and full country name for easier reporting
- The `amount` field represents the monetary value of each conversion, useful for ROI calculations