Candidate analytics

Time spent editing each candidate

Endpoints
GET/candidate_analytics

The candidate analytic object

Attributes

iduuid

Unique identifier

candidate_iduuid | null
candidates.id

Identifier of the related candidate

organization_iduuid | null
organizations.id

Identifier of the related organization

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

time_spentreal

Time spent editing the candidate, in seconds

Related resources

Embed related resources in the response with the select parameter, for example select=*,candidates(*). See selecting data. Resources related through more than one column need the column as a hint, like table!column(*).

candidates(*)object | null
candidates.id

The candidate referenced by candidate_id.

organizations(*)object | null
organizations.id

The organization referenced by organization_id.

The candidate analytic object
JSON
{
  "id": "00000000-0000-0000-0000-000000000000",
  "candidate_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-01-01T12:00:00+00:00",
  "updated_at": "2026-01-01T12:00:00+00:00",
  "time_spent": 0
}
Including related resources
curl "https://api.cv-transformer.com/v1/candidate_analytics?limit=10&select=*,candidates(*),organizations(*)" \
  -H "Authorization: Bearer YOUR_API_KEY"

List candidate analytics

Requirescandidates:read

Filters

idFilter<uuid>

Unique identifier

candidate_idFilter<uuid | null>
candidates.id

Identifier of the related candidate

organization_idFilter<uuid | null>
organizations.id

Identifier of the related organization

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

time_spentFilter<real>

Time spent editing the candidate, in seconds

Responses

200

A list of candidate analytics with the selected columns. The Content-Range header holds the range returned and the total count, like 0-9/42.

206

Partial Content

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

403

The API key doesn't have the scope this request needs.

429

The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the Retry-After header.

Errors have a JSON body with a message, details and hint, and for database errors a code. See errors.
GET/candidate_analytics
curl "https://api.cv-transformer.com/v1/candidate_analytics?limit=10&select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "candidate_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-01-01T12:00:00+00:00",
    "updated_at": "2026-01-01T12:00:00+00:00",
    "time_spent": 0
  }
]