Skip to content

Get activity summary for a grant

GET
/v1/grants/{id}/activity/summary
curl --request GET \
--url https://example.com/v1/grants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activity/summary \
--header 'X-API-Key: <X-API-Key>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
id
required
string format: uuid
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Activity summary

Media type application/json
object
total_events
required
integer
read_events
required
integer
write_events
required
integer
denied_events
required
integer
error_events
required
integer
services
required
Array<string>
Example generated
{
"total_events": 1,
"read_events": 1,
"write_events": 1,
"denied_events": 1,
"error_events": 1,
"services": [
"example"
]
}

Unauthorized

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Grant not found

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}