Returns the project’s Insights event streams: default, for events your applications send, and internal, for events Honeybadger records about the project (errors, deploys, uptime checks and check-ins). A new project’s streams can take a moment to appear.
Stream ID: 12 lowercase hex characters, randomly assigned. Pass it in stream_ids when querying.
data[].name
string
Display name.
data[].slug
string
Stable short name. Allowed values: default, internal.
data[].internal
boolean
True for the stream carrying Honeybadger-generated event types (notice, deploy, uptime_check, check_in). Those event classes are only queryable when this stream is selected.
data[].project_id
string
ID of the project this stream belongs to.
data[].created_at
date-time
pagination
object
Offset-based pagination information.
pagination.pagerequired
integer
Current page number. Min 1.
pagination.per_pagerequired
integer
Items per page. Min 1, max 100.
links
object
Navigation links for a numbered-page collection. Each link is a root-relative path (/v3/...); resolve it against the API host.
links.selfrequired
uri-reference
This page.
links.first
uri-reference
First page.
links.prev
string | null
Previous page, or null on the first page.
links.next
string | null
Next page, or null on the last page.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
Errors
5
401Unauthorized
The credential is missing, invalid, expired or revoked (unauthorized), or was sent in a way v3 doesn’t accept (see the examples).
Example payload: unauthorized (Missing, malformed, expired or revoked credential)
{
"error": {
"code": "unauthorized",
"message": "Access denied"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: unsupported_auth_scheme (Sent as HTTP basic, which v3 does not accept)
{
"error": {
"code": "unsupported_auth_scheme",
"message": "Send the credential as `Authorization: Bearer <token>`; v3 does not accept HTTP basic"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: credential_in_query (Sent as the `auth_token` query parameter)
{
"error": {
"code": "credential_in_query",
"message": "Credentials must be sent in the Authorization header"
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
403Forbidden
The credential isn’t allowed to do this. error.code says why. An account or project the credential doesn’t cover is 404 not_found, not 403.
Example payload: access_denied (The credential isn't allowed to do this to this record)
{
"error": {
"code": "access_denied",
"message": "Access denied"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: insufficient_scope (The credential lacks the permission this endpoint requires)
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient scope",
"details": {
"required_scope": "faults:write",
"token_scopes": [
"faults:read",
"insights:read"
]
}
},
"meta": {
"request_id": "abc123"
}
}
Example payload: requires_user_token (The endpoint records who acted, and an account token has nobody)
{
"error": {
"code": "requires_user_token",
"message": "This endpoint records the person who acted, so it requires a user credential rather than an account token"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: project_restricted (A project-restricted credential cannot create a project)
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
422Unprocessable Content
No path names the account, so the API token has to. This is returned when the token covers more than one account and the account a request applies to cannot be determined. Use a token bound to a single account.
Example payload
{
"error": {
"code": "ambiguous_account",
"message": "This credential covers more than one account, so the account a request applies to is ambiguous. Use a token bound to a single account."
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
429Too Many Requests
Rate limit exceeded. The limit is per credential owner per hour: a person’s tokens share one budget, and an account token uses the account’s. Wait Retry-After seconds and retry.
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
