Skip to main content
POST
Credential Activity

Description

Returns what people did with your credentials: views, shares, downloads and clicks. Each event is one row, oldest first. Use it to build your own engagement reports. You can ask for up to 31 days at a time. For a longer period, make one call for each month. You can also call it with GET and send the parameters in the query string, for example ?from=2026-03-01&to=2026-03-31&event=view,share.

Headers

string
required
Your API key: Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.

Body Parameters

string
required
First day, as YYYY-MM-DD (UTC). The day is included.
string
required
Last day, as YYYY-MM-DD (UTC). The day is included. It must not be before from, and the range can be 31 days at most.
array[string]
The kinds of event to return. Default: all of them.
  • view: someone opened the credential’s page.
  • share: someone shared the credential, for example to LinkedIn.
  • download: someone downloaded the credential as a PDF.
  • click: any other click, such as verify, add to wallet or the group’s link. It also counts the recipient opening the credential email.
You can also send them as one string, separated by commas: "view,share".
string
Only events of credentials in this group.
string
Only events of this credential (its document_id). If you also send group_key, the credential must be in that group.
number
default:"1"
Page number. Starts at 1.
number
default:"100"
How many events on each page. From 1 to 500.

Success Response Fields

boolean
true when the request worked.
string
First day of the range, as YYYY-MM-DD.
string
Last day of the range, as YYYY-MM-DD.
number
The page number of this response.
number
The page size used.
number
Number of events in the range, on all pages.
array[object]
The events on this page, oldest first.
The visitor’s IP address and city are never returned.

Responses

Last modified on October 20, 2026