Analytics

Overview

The Analytics API provides comprehensive metrics and insights for your recruitment process. It exposes data for candidates, interviews, and candidate interviews (phone screens), allowing you to track performance, completion rates, and feedback.

Get Analytics

Retrieve comprehensive analytics data grouped by resource type. Endpoint: GET /qsi/gather/analytics

cURL
JavaScript
Python

curl -X GET https://api.prod.qualifi.hr/qsi/gather/analytics \
  -H "x-api-key: ${API_KEY}"

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/analytics', {
  method: 'GET',
  headers: {
    'x-api-key': apiKey
  }
});
const analytics = await response.json();

import requests

response = requests.get(
    'https://api.prod.qualifi.hr/qsi/gather/analytics',
    headers={
        'x-api-key': api_key
    }
)
analytics = response.json()

Custom Date Range

cURL
JavaScript
Python

curl -X GET "https://api.prod.qualifi.hr/qsi/gather/analytics?startDate=2023-01-01&endDate=2023-03-31" \
  -H "x-api-key: ${API_KEY}"

const params = new URLSearchParams({
  startDate: '2023-01-01',
  endDate: '2023-03-31'
});

const response = await fetch(`https://api.prod.qualifi.hr/qsi/gather/analytics?${params}`, {
  method: 'GET',
  headers: {
    'x-api-key': apiKey
  }
});
const analytics = await response.json();

import requests

params = {
    'startDate': '2023-01-01',
    'endDate': '2023-03-31'
}

response = requests.get(
    'https://api.prod.qualifi.hr/qsi/gather/analytics',
    headers={'x-api-key': api_key},
    params=params
)
analytics = response.json()

Filter by User

cURL
JavaScript
Python

curl -X GET "https://api.prod.qualifi.hr/qsi/gather/analytics?userId=user-uuid" \
  -H "x-api-key: ${API_KEY}"

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/analytics?userId=user-uuid', {
  method: 'GET',
  headers: {
    'x-api-key': apiKey
  }
});
const analytics = await response.json();

import requests

response = requests.get(
    'https://api.prod.qualifi.hr/qsi/gather/analytics',
    headers={'x-api-key': api_key},
    params={'userId': 'user-uuid'}
)
analytics = response.json()

Filter by Interview Template

cURL
JavaScript
Python

curl -X GET "https://api.prod.qualifi.hr/qsi/gather/analytics?interviewId=interview-uuid" \
  -H "x-api-key: ${API_KEY}"

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/analytics?interviewId=interview-uuid', {
  method: 'GET',
  headers: {
    'x-api-key': apiKey
  }
});
const analytics = await response.json();

import requests

response = requests.get(
    'https://api.prod.qualifi.hr/qsi/gather/analytics',
    headers={'x-api-key': api_key},
    params={'interviewId': 'interview-uuid'}
)
analytics = response.json()

{
  "data": {
    "candidates": {
      "total": 150,
      "archived": 45
    },
    "interviews": {
      "total": 10,
      "active": 8,
      "archived": 2,
      "standard": 8,
      "questionnaire": 2
    },
    "candidateInterviews": {
      "total": 100,
      "statusBreakdown": {
        "inviteSent": 20,
        "newResponse": 15,
        "hasReviewed": 30,
        "partiallyCompleted": 5,
        "hired": 5,
        "archived": 20,
        "expired": 5
      },
      "completed": 50,
      "incomplete": 25,
      "completionRate": 0.5,
      "averageResponseTime": "2 days",
      "averageResponseTimeInHours": 48,
      "hoursSaved": 25,
      "positiveFeedbackPercentage": 80
    },
    "dateRange": {
      "startDate": "2023-01-01T00:00:00.000Z",
      "endDate": "2023-01-31T23:59:59.999Z"
    }
  },
  "meta": {
    "requestId": "req-123",
    "timestamp": "2023-02-01T12:00:00.000Z",
    "cached": false
  }
}

Response Structure

Candidates Analytics

Metrics related to candidate entities.

total: Total unique candidates found in the date range
archived: Candidates that have been archived

Interviews Analytics

Metrics related to interview templates. These metrics are generally scoped to the team and organization, not strictly by date range (showing currently available templates).

total: Total interview templates
active: Currently active templates
archived: Archived templates
standard: Standard audio interviews
questionnaire: Text-based questionnaire interviews

Candidate Interviews Analytics

Metrics related to interview instances (phone screens) assigned to candidates. This is the primary section for performance metrics.

total: Total interview instances in the date range
statusBreakdown: Detailed count of interviews by current status
- inviteSent: Invites that have been sent
- newResponse: New responses awaiting review
- hasReviewed: Responses that have been reviewed
- partiallyCompleted: Partially completed interviews
- hired: Candidates marked as hired
- archived: Archived interviews
- expired: Expired interviews
completed: Count of completed interviews
incomplete: Count of incomplete interviews
completionRate: Ratio of completed interviews to total interviews (0.0 to 1.0)
averageResponseTime: Human-readable average time from invite to completion
averageResponseTimeInHours: Numeric average response time in hours
hoursSaved: Estimated hours saved based on completed interviews (0.5 hours per interview)
positiveFeedbackPercentage: Percentage of interviews rated positively

Caching Behavior

To ensure performance, analytics results are cached based on the queried date range:

Date range ≤ 1 day: Cached for 5 minutes
Date range 2-7 days: Cached for 15 minutes
Date range 8-30 days: Cached for 1 hour
Date range > 30 days: Cached for 2 hours

The meta.cached field in the response indicates if the data was served from cache (true) or computed fresh (false).

Error Responses

{
  "code": "UNAUTHORIZED",
  "message": "Missing organization context",
  "meta": {
    "requestId": "req-123",
    "timestamp": "2023-02-01T12:00:00.000Z"
  }
}

Get Started

API Reference

Guides

Code Examples

Resources

Overview

Get Analytics

Custom Date Range

Filter by User

Filter by Interview Template

Response Structure

Candidates Analytics

Interviews Analytics

Candidate Interviews Analytics

Caching Behavior

Error Responses

Get Started

API Reference

Guides

Code Examples

Resources

​Overview

​Get Analytics

​Custom Date Range

​Filter by User

​Filter by Interview Template

​Response Structure

​Candidates Analytics

​Interviews Analytics

​Candidate Interviews Analytics

​Caching Behavior

​Error Responses

Overview

Get Analytics

Custom Date Range

Filter by User

Filter by Interview Template

Response Structure

Candidates Analytics

Interviews Analytics

Candidate Interviews Analytics

Caching Behavior

Error Responses