Skip to main content
GET
/
api
/
sessions
/
reporting
List sessions
curl --request GET \
  --url https://app.coragents.ai/api/sessions/reporting \
  --header 'Authorization: <api-key>'
{
  "sessions": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "completed",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "duration_minutes": 45,
      "plan": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Getting Started"
      },
      "onboardee": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Jane Smith",
        "email": "jane@example.com",
        "company": "Acme Corp"
      },
      "summary": "Completed onboarding walkthrough covering dashboard and settings.",
      "feedback": "User found the dashboard navigation intuitive."
    }
  ],
  "total": 142,
  "page": 1,
  "limit": 25,
  "total_pages": 6
}

Authorizations

​
Authorization
string
header
required

API token using the Token scheme. Send the full header value as Token <your-api-token>. Tokens are provisioned by the Cor team.

Query Parameters

​
onboardee_uuid
string<uuid>

Filter by onboardee UUID.

​
plan_uuid
string<uuid>

Filter by onboarding plan UUID.

​
started_at_gt
string<date-time>

Only sessions started after this time (RFC3339).

​
started_at_lt
string<date-time>

Only sessions started before this time (RFC3339).

​
finished_at_gt
string<date-time>

Only sessions finished after this time (RFC3339).

​
finished_at_lt
string<date-time>

Only sessions finished before this time (RFC3339).

​
page
integer
default:1

Page number (1-based).

Required range: x >= 1
​
limit
integer
default:25

Items per page.

Required range: 1 <= x <= 100

Response

A page of sessions.

​
sessions
object[]
​
total
integer
Example:

142

​
page
integer
Example:

1

​
limit
integer
Example:

25

​
total_pages
integer
Example:

6