Get Job Visitors

curl -X GET \
  "https://api.kardow.com/analytics/jobs?jobIds=123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001&period=30d" \
  -H "x-api-key: your-api-key-here"

const apiKey = process.env.KARDOW_API_KEY;
const jobIds = [
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174001'
];

const response = await fetch(
  `https://api.kardow.com/analytics/jobs?jobIds=${jobIds.join(',')}&period=30d`,
  {
    headers: {
      'x-api-key': apiKey
    }
  }
);

const data = await response.json();
console.log('Visitor data:', data.data.visitors);

import os
import requests

api_key = os.environ.get('KARDOW_API_KEY')
job_ids = [
    '123e4567-e89b-12d3-a456-426614174000',
    '123e4567-e89b-12d3-a456-426614174001'
]

url = 'https://api.kardow.com/analytics/jobs'
params = {
    'jobIds': ','.join(job_ids),
    'period': '30d'
}
headers = {
    'x-api-key': api_key
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print('Visitor data:', data['data']['visitors'])

<?php
$apiKey = getenv('KARDOW_API_KEY');
$jobIds = [
    '123e4567-e89b-12d3-a456-426614174000',
    '123e4567-e89b-12d3-a456-426614174001'
];

$url = 'https://api.kardow.com/analytics/jobs';
$queryParams = http_build_query([
    'jobIds' => implode(',', $jobIds),
    'period' => '30d'
]);

$ch = curl_init("$url?$queryParams");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: $apiKey"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data['data']['visitors']);
?>

{
  "data": {
    "visitors": {
      "123e4567-e89b-12d3-a456-426614174000": 150,
      "123e4567-e89b-12d3-a456-426614174001": 320
    }
  },
  "meta": {
    "period": "30d",
    "total_jobs": 2
  }
}

{
  "error": {
    "message": "API key is required",
    "code": "missing_api_key",
    "details": "Please provide an API key in the x-api-key header",
    "url": "https://kardow.featurebase.app/help/articles/api-documentation"
  }
}

{
  "error": {
    "message": "Invalid API key",
    "code": "invalid_api_key",
    "details": "The provided API key is invalid or expired",
    "url": "https://kardow.featurebase.app/help/articles/api-documentation"
  }
}

{
  "error": {
    "message": "Missing required parameter",
    "code": "missing_parameter",
    "details": "jobIds parameter is required (comma-separated list of UUIDs)",
    "url": "https://kardow.com/help/api/get-job-analytics-with-the-api"
  }
}

{
  "error": {
    "message": "Invalid job IDs",
    "code": "forbidden",
    "details": "The following job IDs do not belong to your organization or do not exist: 123e4567-e89b-12d3-a456-426614174002",
    "url": "https://kardow.com/help/api/get-job-analytics-with-the-api"
  }
}

GET

analytics

job-visitors

curl -X GET \
  "https://api.kardow.com/analytics/jobs?jobIds=123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001&period=30d" \
  -H "x-api-key: your-api-key-here"

const apiKey = process.env.KARDOW_API_KEY;
const jobIds = [
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174001'
];

const response = await fetch(
  `https://api.kardow.com/analytics/jobs?jobIds=${jobIds.join(',')}&period=30d`,
  {
    headers: {
      'x-api-key': apiKey
    }
  }
);

const data = await response.json();
console.log('Visitor data:', data.data.visitors);

import os
import requests

api_key = os.environ.get('KARDOW_API_KEY')
job_ids = [
    '123e4567-e89b-12d3-a456-426614174000',
    '123e4567-e89b-12d3-a456-426614174001'
]

url = 'https://api.kardow.com/analytics/jobs'
params = {
    'jobIds': ','.join(job_ids),
    'period': '30d'
}
headers = {
    'x-api-key': api_key
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print('Visitor data:', data['data']['visitors'])

<?php
$apiKey = getenv('KARDOW_API_KEY');
$jobIds = [
    '123e4567-e89b-12d3-a456-426614174000',
    '123e4567-e89b-12d3-a456-426614174001'
];

$url = 'https://api.kardow.com/analytics/jobs';
$queryParams = http_build_query([
    'jobIds' => implode(',', $jobIds),
    'period' => '30d'
]);

$ch = curl_init("$url?$queryParams");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: $apiKey"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data['data']['visitors']);
?>

{
  "data": {
    "visitors": {
      "123e4567-e89b-12d3-a456-426614174000": 150,
      "123e4567-e89b-12d3-a456-426614174001": 320
    }
  },
  "meta": {
    "period": "30d",
    "total_jobs": 2
  }
}

{
  "error": {
    "message": "API key is required",
    "code": "missing_api_key",
    "details": "Please provide an API key in the x-api-key header",
    "url": "https://kardow.featurebase.app/help/articles/api-documentation"
  }
}

{
  "error": {
    "message": "Invalid API key",
    "code": "invalid_api_key",
    "details": "The provided API key is invalid or expired",
    "url": "https://kardow.featurebase.app/help/articles/api-documentation"
  }
}

{
  "error": {
    "message": "Missing required parameter",
    "code": "missing_parameter",
    "details": "jobIds parameter is required (comma-separated list of UUIDs)",
    "url": "https://kardow.com/help/api/get-job-analytics-with-the-api"
  }
}

{
  "error": {
    "message": "Invalid job IDs",
    "code": "forbidden",
    "details": "The following job IDs do not belong to your organization or do not exist: 123e4567-e89b-12d3-a456-426614174002",
    "url": "https://kardow.com/help/api/get-job-analytics-with-the-api"
  }
}

Authentication

This endpoint requires API key authentication. Include your API key in the request header:

x-api-key: your-api-key-here

You can generate API keys from your organization settings in the Kardow dashboard under Settings > API Keys.

Query Parameters

jobIds

string

required

Comma-separated list of job UUIDs to fetch visitor counts for. Maximum 100 job IDs per request.Example: 123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001

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

Response

data

object

The analytics data for the requested jobs

Show data properties

visitors

object

Map of job IDs to their visitor counts

{
  "123e4567-e89b-12d3-a456-426614174000": 150,
  "123e4567-e89b-12d3-a456-426614174001": 320
}

meta

object

Metadata about the request

Show meta properties

period

string

The time period used for the analytics query

total_jobs

number

Total number of jobs included in the query

curl -X GET \
  "https://api.kardow.com/analytics/jobs?jobIds=123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001&period=30d" \
  -H "x-api-key: your-api-key-here"

const apiKey = process.env.KARDOW_API_KEY;
const jobIds = [
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174001'
];

const response = await fetch(
  `https://api.kardow.com/analytics/jobs?jobIds=${jobIds.join(',')}&period=30d`,
  {
    headers: {
      'x-api-key': apiKey
    }
  }
);

const data = await response.json();
console.log('Visitor data:', data.data.visitors);

import os
import requests

api_key = os.environ.get('KARDOW_API_KEY')
job_ids = [
    '123e4567-e89b-12d3-a456-426614174000',
    '123e4567-e89b-12d3-a456-426614174001'
]

url = 'https://api.kardow.com/analytics/jobs'
params = {
    'jobIds': ','.join(job_ids),
    'period': '30d'
}
headers = {
    'x-api-key': api_key
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print('Visitor data:', data['data']['visitors'])

<?php
$apiKey = getenv('KARDOW_API_KEY');
$jobIds = [
    '123e4567-e89b-12d3-a456-426614174000',
    '123e4567-e89b-12d3-a456-426614174001'
];

$url = 'https://api.kardow.com/analytics/jobs';
$queryParams = http_build_query([
    'jobIds' => implode(',', $jobIds),
    'period' => '30d'
]);

$ch = curl_init("$url?$queryParams");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: $apiKey"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data['data']['visitors']);
?>

{
  "data": {
    "visitors": {
      "123e4567-e89b-12d3-a456-426614174000": 150,
      "123e4567-e89b-12d3-a456-426614174001": 320
    }
  },
  "meta": {
    "period": "30d",
    "total_jobs": 2
  }
}

{
  "error": {
    "message": "API key is required",
    "code": "missing_api_key",
    "details": "Please provide an API key in the x-api-key header",
    "url": "https://kardow.featurebase.app/help/articles/api-documentation"
  }
}

{
  "error": {
    "message": "Invalid API key",
    "code": "invalid_api_key",
    "details": "The provided API key is invalid or expired",
    "url": "https://kardow.featurebase.app/help/articles/api-documentation"
  }
}

{
  "error": {
    "message": "Missing required parameter",
    "code": "missing_parameter",
    "details": "jobIds parameter is required (comma-separated list of UUIDs)",
    "url": "https://kardow.com/help/api/get-job-analytics-with-the-api"
  }
}

{
  "error": {
    "message": "Invalid job IDs",
    "code": "forbidden",
    "details": "The following job IDs do not belong to your organization or do not exist: 123e4567-e89b-12d3-a456-426614174002",
    "url": "https://kardow.com/help/api/get-job-analytics-with-the-api"
  }
}

Security

This endpoint implements multiple security layers:

API Key Authentication - Only valid API keys can access the endpoint
Organization Scoping - You can only access jobs belonging to your organization
Job Ownership Validation - All requested job IDs are verified to belong to your organization
Domain Validation - Analytics are fetched only from your organization’s verified domain

Rate Limits

API requests are subject to rate limits:

100 requests per minute per API key
10 concurrent requests maximum

When you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

Best Practices

Batch Multiple Jobs

Instead of making individual requests for each job, batch multiple job IDs in a single request:

// Making 50 requests
for (const jobId of jobIds) {
  await fetch(`https://api.kardow.com/analytics/jobs?jobIds=${jobId}`);
}

// Making 1 request for up to 100 jobs
const jobIdsBatch = jobIds.slice(0, 100).join(',');
await fetch(`https://api.kardow.com/analytics/jobs?jobIds=${jobIdsBatch}`);

Implement Error Handling

Always implement proper error handling with retries:

async function getAnalyticsWithRetry(jobIds, maxRetries = 3) {
  let lastError;

  for (let i = 0; i < maxRetries; i++) {
    try {
      const response = await fetch(
        `https://api.kardow.com/analytics/jobs?jobIds=${jobIds.join(',')}`,
        { headers: { 'x-api-key': apiKey } }
      );

      if (response.status === 429) {
        // Rate limited - wait and retry
        await new Promise(resolve => setTimeout(resolve, 2000 * (i + 1)));
        continue;
      }

      if (!response.ok) {
        const error = await response.json();
        throw new Error(error.error.message);
      }

      return await response.json();
    } catch (error) {
      lastError = error;
      if (i < maxRetries - 1) {
        await new Promise(resolve => setTimeout(resolve, 1000 * (i + 1)));
      }
    }
  }

  throw lastError;
}

Cache Results

Cache analytics data to reduce API calls:

const cache = new Map();
const CACHE_TTL = 5 * 60 * 1000; // 5 minutes

async function getCachedAnalytics(jobIds) {
  const cacheKey = jobIds.sort().join(',');
  const cached = cache.get(cacheKey);

  if (cached && Date.now() - cached.timestamp < CACHE_TTL) {
    return cached.data;
  }

  const data = await getJobAnalytics(jobIds);
  cache.set(cacheKey, { data, timestamp: Date.now() });
  return data;
}

Common Use Cases

Dashboard Integration

Display visitor analytics in your custom dashboard:

async function buildJobDashboard(jobIds) {
  const analytics = await getJobAnalytics(jobIds);

  return jobIds.map(jobId => ({
    jobId,
    visitors: analytics.data.visitors[jobId] || 0,
    // Add other job data
  }));
}

Weekly Performance Reports

Generate automated reports of job performance:

async function generateWeeklyReport() {
  const jobs = await getAllActiveJobs();
  const jobIds = jobs.map(j => j.id);

  const analytics = await getJobAnalytics(jobIds);

  const report = {
    period: analytics.meta.period,
    totalVisitors: Object.values(analytics.data.visitors)
      .reduce((a, b) => a + b, 0),
    topJobs: Object.entries(analytics.data.visitors)
      .sort(([, a], [, b]) => b - a)
      .slice(0, 10)
      .map(([jobId, visitors]) => ({
        job: jobs.find(j => j.id === jobId),
        visitors
      }))
  };

  return report;
}

Comparative Analysis

Compare performance across different time periods:

async function comparePerformance(jobIds) {
  const [last7Days, last30Days] = await Promise.all([
    getJobAnalytics(jobIds, '7d'),
    getJobAnalytics(jobIds, '30d')
  ]);

  return jobIds.map(jobId => ({
    jobId,
    last7Days: last7Days.data.visitors[jobId] || 0,
    last30Days: last30Days.data.visitors[jobId] || 0,
    averageDaily: (last30Days.data.visitors[jobId] || 0) / 30
  }));
}

Site Analytics

Get comprehensive analytics with filtering options

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.

Query Parameters

jobIds

string

required

Comma-separated list of job UUIDs (max 100)

Example:

"123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001"

period

enum<string>

default:30d

Time period for analytics

Available options:

7d,

30d,

6mo,

12mo

Response

Success

data

object

Show child attributes

Getting Started

Analytics

Jobs

Applications

Content

Members

Users

Webhooks

CMS

Get Job Visitors

Authentication

Query Parameters

Response

Security

Rate Limits

Best Practices

Batch Multiple Jobs

Implement Error Handling

Cache Results

Common Use Cases

Dashboard Integration

Weekly Performance Reports

Comparative Analysis

Site Analytics

List Jobs

Authorizations

Query Parameters

Response

​Authentication

​Query Parameters

​Response

​Security

​Rate Limits

​Best Practices

​Batch Multiple Jobs

​Implement Error Handling

​Cache Results

​Common Use Cases

​Dashboard Integration

​Weekly Performance Reports

​Comparative Analysis

​Related Endpoints

Site Analytics

List Jobs

Authorizations

Query Parameters

Response

Authentication

Query Parameters

Response

Security

Rate Limits

Best Practices

Batch Multiple Jobs

Implement Error Handling

Cache Results

Common Use Cases

Dashboard Integration

Weekly Performance Reports

Comparative Analysis

Related Endpoints