Skip to content
Browse documentation

OpenAPI operations

Read workspace delivery statistics

GET
/v1/stats
curl --request GET \
  --url https://api.hooks.events/v1/stats \
  --header 'Authorization: Bearer <token>'

Requires the endpoints:read scope.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
required

Workspace delivery statistics

object
queueDepth
required

Current delivery backlog per endpoint and destination

object
asOf
required

Snapshot time; queue depth is not range-scoped

string
total
required

Deliveries still waiting for an attempt

integer
>= -9007199254740991 <= 9007199254740991
byStatus
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
endpoints
required
Array<object>
object
id
required

Resource id

string
name
required
string
total
required
integer
>= -9007199254740991 <= 9007199254740991
byStatus
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
key
additional properties
destinations
required

Sorted by backlog size

Array<object>
object
id
required

Resource id

string
name
required
string
total
required
integer
>= -9007199254740991 <= 9007199254740991
byStatus
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
key
additional properties
key
additional properties
key
additional properties
key
additional properties

Example generated

{
  "data": {
    "queueDepth": {
      "asOf": "example",
      "total": 1,
      "byStatus": {
        "additionalProperty": 1
      },
      "endpoints": [
        {
          "id": "example",
          "name": "example",
          "total": 1,
          "byStatus": {
            "additionalProperty": 1
          }
        }
      ],
      "destinations": [
        {
          "id": "example",
          "name": "example",
          "total": 1,
          "byStatus": {
            "additionalProperty": 1
          }
        }
      ]
    }
  }
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

401

Section titled “401”

Missing or invalid credentials

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

403

Section titled “403”

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

Requests allowed per window

X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Seconds until the window resets

Retry-After
integer

Seconds to wait before retrying. Absent when the rejection has no retry time (for example the Free lifetime quota).

X-Quota-Limit
integer

Request allowance for the workspace’s plan

X-Quota-Remaining
integer

Requests left in the allowance after this request