Skip to main content
GET
Download CSV Export

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

type
enum<string>
required

What the file contains. prospects: prospects with their connection and engagement numbers; filter by campaignId or listId. comments: comments published on LinkedIn, oldest first; filter by campaignId and the period, no period means all time. statistics: the Dashboard numbers, one row per day; the period is required and keeps the Dashboard limit of 31 days.

Available options:
prospects,
comments,
statistics
campaignId
string<uuid>

Optional campaign ID in the caller's scope; omit for every accessible campaign.

listId
string<uuid>

Optional prospect list ID; prospects only.

startDate
string

First calendar day of the period, included, YYYY-MM-DD. Given together with endDate.

Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string

Last calendar day of the period, included, YYYY-MM-DD. Given together with startDate.

Pattern: ^\d{4}-\d{2}-\d{2}$
timezone
string

IANA timezone the calendar days are taken in. Required for statistics (use the user's profile timezone to match the Dashboard); comments uses UTC without it. In the export link it may be omitted: the Extrovert app then uses the visitor's profile timezone.

Minimum string length: 1

Response

The CSV file.

The response is of type string.