Skip to main content
GET
/
api
/
v1
/
telemetry
/
overlay-dismissals
Overlay-dismissal summary
curl --request GET \
  --url https://api.empirical.run/api/v1/telemetry/overlay-dismissals \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "project": {
      "id": 123,
      "name": "<string>",
      "repo_name": "<string>"
    },
    "summary": {
      "total": 123,
      "success_count": 123,
      "success_rate": 123,
      "cache_hit_count": 123,
      "cache_hit_rate": 123,
      "avg_duration_ms": 123,
      "total_cost": 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

Overlay-dismissal summary for the project.

​
data
object
required

Response payload.