Skip to content
Convor
Convor Docs
API ReferenceVisitors

Export visitors as CSV

Streams up to 1000 visitors as a CSV file using the same filtering options as the visitor list route.

GET/api/visitors/export/csv

Streams up to 1000 visitors as a CSV file using the same filtering options as the visitor list route. The export format is always CSV, and omitted filters behave the same way they do on the visitor list endpoint. Results are ordered by most recent visitor activity first. Stream the CSV response and use the filename from Content-Disposition.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
visitors:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
search?string

Query parameter. Search text.

Lengthlength <= 200
status?string

Query parameter. Status. Allowed values: online, offline.

Value in

  • "online"
  • "offline"
tags?array<>

Query parameter. Tags assigned to this resource.

blocked?string

Query parameter. Value of blocked.

minVisits?integer

Query parameter. Value of minVisits.

Range0 <= value <= 9007199254740991
maxVisits?integer

Query parameter. Value of maxVisits.

Range0 <= value <= 9007199254740991
lastSeenFrom?string

Query parameter. ISO 8601 date and time for lastSeenFrom.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
lastSeenTo?string

Query parameter. ISO 8601 date and time for lastSeenTo.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
scope?"all"

Query parameter. Scope. Allowed values: all.

Value in

  • "all"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

"ID,Identifier,Email,Name,City,Country,Sessions,First Seen,Last Seen,Tags,Blocked\n\"visitor_123\",\"[email protected]\",\"[email protected]\",\"Jane Doe\",\"Warsaw\",\"PL\",\"3\",\"2026-06-01T08:00:00.000Z\",\"2026-06-23T09:30:00.000Z\",\"vip\",\"No\""

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/visitors/export/csv' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/visitors/export/csv", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Edit a visitor note

Updates the text of one existing visitor note and keeps its other note fields, including pin state and author metadata, unchanged.

Get visitor browsing history

Returns the visitor's page history and time spent on each page.

On this page

Request examplescurlJavaScript