Skip to main content
POST

Authentication

This endpoint requires API key authentication. Include your API key in the request header:
You can generate API keys from your organization settings in the Kardow dashboard under Settings > API Keys.

Request Body

period
string
default:"30d"
Time period for analytics data. Must be one of:
  • 7d - Last 7 days
  • 30d - Last 30 days
  • 6mo - Last 6 months
  • 12mo - Last 12 months
  • custom - Custom date range (requires dateRange parameter)
dateRange
object
Custom date range (required if period is custom)
filters
object
Advanced filtering options for analytics data
includeComparison
boolean
default:true
Include comparison with the previous period. When enabled, the response includes percentage changes for all metrics compared to the equivalent previous time period.

Response

data
object
Comprehensive analytics data
meta
object
Metadata about the request

Filtering Capabilities

The full analytics endpoint supports extensive filtering to help you analyze specific segments of your traffic:

Device Filtering

Filter analytics by device type to understand how users access your job board:

Geographic Filtering

Analyze traffic from specific countries using ISO country codes:

Traffic Source Filtering

Understand which sources drive the most traffic:

UTM Campaign Tracking

Track specific marketing campaigns:

Combined Filters

Combine multiple filters for advanced segmentation:

Understanding Comparison Data

When includeComparison is enabled, the API automatically calculates period-over-period changes:
How the comparison works:
  • For preset periods (7d, 30d, etc.), the previous period is the equivalent time span immediately before the current period
  • For custom date ranges, the previous period is calculated based on the duration of your custom range
  • Positive change values indicate growth
  • Negative change values indicate decline

Use Cases

Performance Dashboard

Build a comprehensive performance dashboard:

Mobile vs Desktop Analysis

Compare performance across device types:

Geographic Performance Report

Analyze which countries drive the most engagement:

Marketing Campaign Analysis

Track UTM campaign performance:

Best Practices

Cache Results

Cache analytics data for 5-10 minutes to reduce API calls and improve performance.

Use Filters Wisely

Combine filters to get specific insights, but avoid over-filtering which may result in insufficient data.

Monitor Comparisons

Enable comparisons to track trends and identify performance changes over time.

Batch Requests

If you need multiple filtered views, consider making parallel requests for better performance.

Rate Limits

This endpoint is subject to rate limits:
  • 50 requests per minute per API key
  • 5 concurrent requests maximum
More restrictive than the job-visitors endpoint due to the comprehensive nature of the data.

Job Visitors

Get visitor counts for specific jobs

List Jobs

Retrieve your job listings

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours from Settings > API Keys in the Kardow dashboard.

Body

application/json
period
enum<string>
default:30d

Time period for analytics data

Available options:
7d,
30d,
6mo,
12mo,
custom
dateRange
object

Custom date range (required if period is 'custom')

filters
object

Advanced filtering options

includeComparison
boolean
default:true

Include period-over-period comparison (value + percentage change per metric) in data.comparison. Defaults to true.

Response

Success

data
object
meta
object