Skip to main content
GET
/
api
/
v1
/
telemetry
/
overlay-dismissals
/
events
Overlay-dismissal events
curl --request GET \
  --url https://api.empirical.run/api/v1/telemetry/overlay-dismissals/events \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "project": {
      "id": 123,
      "name": "<string>",
      "repo_name": "<string>"
    },
    "events": [
      {
        "timestamp": "<string>",
        "environment": "<string>",
        "repo_name": "<string>",
        "project_name": "<string>",
        "test_run_id": "<string>",
        "test_name": "<string>",
        "success": true,
        "cache_hit": true,
        "duration_ms": 123,
        "overlay_description": "<string>",
        "overlay_text": "<string>",
        "original_locator": "<string>",
        "tokens_input": 123,
        "tokens_output": 123,
        "cost_input": 123,
        "cost_output": 123
      }
    ]
  },
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
string

Page number (1-indexed). Default 1.

per_page
string

Items per page (1-100). Default 50.

days
string

Look-back window in days (1-90, default 7). Ignored when start_date and end_date are set.

start_date
string

Start of a custom date range (ISO 8601).

end_date
string

End of a custom date range (ISO 8601).

environment
string

Filter by environment name.

test_run_id
string

Filter by test run ID.

test_name
string

Case-insensitive substring filter on test name.

success
string

Filter by success: true or false. Other values ignored.

cache_hit
string

Filter by cache hit: true or false. Other values ignored.

Response

Paginated overlay-dismissal events for the project.

data
object
required

Project reference and the page of events.

pagination
object
required

Pagination metadata.