This section provides detailed documentation for each endpoint available in the API Seal Metrics v1.0, including required parameters, optional parameters, example requests, and example responses.
Common Parameters
Before diving into specific endpoints, let's review the common parameters used across multiple endpoints:
Parameter | Type | Description |
account_id | string | Your account identifier (required for most endpoints) |
date_range | string | Date range for the data in format YYYYMMDD,YYYYMMDD or predefined values |
skip | integer | Number of records to skip (for pagination), defaults to 0 |
limit | integer | Maximum number of records to return, defaults to 100 with max value of 100 |
country | string | ISO 3166-1 alpha-2 country code filter (optional) |
utm_medium | string | Filter by medium (e.g., email, cpc, social media) |
utm_source | string | Filter by source (e.g., google, facebook, newsletter) |
utm_campaign | string | Filter by campaign name |
show_utms | boolean | Flag to display UTM parameters (default: false) |
Date Range Options
The `date_range` parameter accepts the following formats:
- Specific date range: `20230601,20230630` (YYYYMMDD,YYYYMMDD)
- Predefined periods:
- `today`
- `yesterday`
- `last_7_days`
- `last_14_days`
- `last_30_days`
- `last_60_days`
- `last_90_days`
- `this_month`
- `last_month`
- `this_week_monday_sunday`
- `this_week_sunday_saturday`
- `this_year`
- `last_year`