Export Login Information

Exporting the login history of a Coveo organization can be useful for finding which Coveo Platform users have logged into an organization over a given number of days.

Use the Get the login information for the organization operation to export a set of login activities for a specific Coveo organization to a CSV file.

Request template

GET https://platform.cloud.coveo.com/rest/organizations/{organizationId}/exports/logins?numberOfDays={numberOfDays} HTTP/1.1

Content-Type: text/csv
Authorization: Bearer <MyAccessToken>

In the request path:

  • Replace {organizationId} with the actual id of the target Coveo organization (see Retrieving the ID of a Coveo Organization).

  • Replace {numberOfDays} with an unsigned integer representing the number of days worth of login information you would like to export (e.g, 7). Default value is 31.

In the Authorization HTTP header:

A successful response returns a CSV file containing the login times and user names of the target Coveo organization within the specified number of days.

The information returned by this operation may be incomplete.

Sample Request

Getting the login information of a Coveo organization

GET https://platform.cloud.coveo.com/rest/organizations/mycoveocloudv2organizationg8tp8wu3/exports/logins?numberOfDays=1 HTTP/1.1

Content-Type: text/csv
Authorization: Bearer **********-****-****-****-************

Successful response - 200 OK

loginDate,username
2018-05-16T15:39:18.702Z,asmith@example.com
2018-05-17T13:40:18.702Z,bjones@example.com
2018-05-17T16:45:10.804Z,cbrown@example.com
Recommended Articles