Get usage

GET/v1/organization/usage

See your organization's usage totals.

Authentication: SignalSitter API credential or Clerk session JWT · REST guide
Operation ID: getOrganizationUsage

Parameters

Headers

X-Correlation-IDCorrelationId

Optional caller correlation identifier propagated to the response.

Minimum length 1
Maximum length 128
Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

Request body

No request body.

Responses

200Successful response

application/jsonOrganizationUsageView

totals is null exactly when freshness is unavailable
the usage window ends no later than the report asOf timestamp

aggregationVersionintegerRequired

Greater than 0
Maximum 9007199254740991

entitlementAlignmentobjectRequired

5 properties

activeMonitorsobjectRequired

4 properties

currentintegerRequired

Minimum 0
Maximum 9007199254740991

limitintegerRequired

Minimum 0
Maximum 9007199254740991

overLimitbooleanRequired

remainingintegerRequired

Minimum 0
Maximum 9007199254740991

apiRequestsPerMinuteintegerRequired

Greater than 0
Maximum 9007199254740991

freshnessobjectRequired

7 properties

assignmentVersionintegerRequired

Greater than 0
Maximum 9007199254740991

checkedAtstringRequired

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

leaseVersionintegerRequired

Greater than 0
Maximum 9007199254740991

lifecycleGenerationintegerRequired

Minimum 0
Maximum 9007199254740991

modestringRequired

One of

"fresh"
"offline_grace"

offlineUntilstringRequired

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

refreshAfterstringRequired

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

mcpRequestsPerMinuteintegerRequired

Greater than 0
Maximum 9007199254740991

planobjectRequired

3 properties

idstringRequired

One of

"free"
"builder"
"smart"
"scale"

namestringRequired

Minimum length 1
Maximum length 64
Pattern ^[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

versionintegerRequired

Greater than 0
Maximum 9007199254740991

freshnessobjectRequired

5 properties

asOfstringRequired

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

coverageobjectRequired

4 properties

expectedAuthoritiesintegerRequired

Minimum 0
Maximum 9007199254740991

reconciledAuthoritiesintegerRequired

Minimum 0
Maximum 9007199254740991

requestCallsstringRequired

One of

"complete"
"lower_bound"
"unavailable"

statestringRequired

One of

"complete"
"partial"
"unavailable"

projectedAtstring

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

sourceUpdatedAtstring

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

statestringRequired

One of

"fresh"
"delayed"
"stale"
"unavailable"

organizationIdstringRequired

Minimum length 1
Maximum length 128
Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$

reconciliationobjectRequired

3 properties

exactGlobalQuotabooleanRequired

Value

false

modestringRequired

Value

"eventual_reconciliation"

notestringRequired

Value

"Usage is reconciled after durable regional projections; it is not exact global quota enforcement."

selectedProjectobject

2 properties

projectIdstringRequired

Minimum length 1
Maximum length 128
Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$

totalsobject | nullRequired

10 properties

activeMonitorSecondsintegerRequired

Minimum 0
Maximum 9007199254740991

beatsintegerRequired

Minimum 0
Maximum 9007199254740991

deliveryAttemptsintegerRequired

Minimum 0
Maximum 9007199254740991

detectorCpuHighintegerRequired

Minimum 0
Maximum 9007199254740991

detectorCpuLowintegerRequired

Minimum 0
Maximum 9007199254740991

detectorCpuMediumintegerRequired

Minimum 0
Maximum 9007199254740991

incidentsintegerRequired

Minimum 0
Maximum 9007199254740991

measurementsintegerRequired

Minimum 0
Maximum 9007199254740991

payloadBytesintegerRequired

Minimum 0
Maximum 9007199254740991

storageBytesintegerRequired

Minimum 0
Maximum 9007199254740991

totalsobject | nullRequired

12 properties

activeMonitorSecondsintegerRequired

Minimum 0
Maximum 9007199254740991

apiCallsintegerRequired

Minimum 0
Maximum 9007199254740991

beatsintegerRequired

Minimum 0
Maximum 9007199254740991

deliveryAttemptsintegerRequired

Minimum 0
Maximum 9007199254740991

detectorCpuHighintegerRequired

Minimum 0
Maximum 9007199254740991

detectorCpuLowintegerRequired

Minimum 0
Maximum 9007199254740991

detectorCpuMediumintegerRequired

Minimum 0
Maximum 9007199254740991

incidentsintegerRequired

Minimum 0
Maximum 9007199254740991

mcpCallsintegerRequired

Minimum 0
Maximum 9007199254740991

measurementsintegerRequired

Minimum 0
Maximum 9007199254740991

payloadBytesintegerRequired

Minimum 0
Maximum 9007199254740991

storageBytesintegerRequired

Minimum 0
Maximum 9007199254740991

windowobjectRequired

2 properties

endsAtstringRequired

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

startsAtstringRequired

Format date-time
Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

2 response headers

X-Correlation-IDCorrelationIdRequired

Correlation identifier shared by related operations.

Minimum length 1
Maximum length 128
Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

X-Request-IDRequestIdRequired

Request identifier for this response.

Minimum length 1
Maximum length 128
Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

Errors

400Invalid request
401Authentication required
403Permission denied
404Resource not found
429Authentication rate limited
500Internal server error
503Service temporarily unavailable

Error bodyProblemDetails

application/problem+jsonProblemDetails

URI references must pass full URI-reference parsing, including percent escapes, authority brackets, and scheme syntax.
Documentation links must parse as credential-free HTTPS URLs or root-relative paths.
retryAfterSeconds is allowed only when retryable is true.

codestringRequired

Minimum length 1
Maximum length 128
Pattern ^signalsitter\.[a-z][a-z0-9]*(?:[._][a-z0-9]+)*$

correlationIdstringRequired

Minimum length 1
Maximum length 128
Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

detailstringRequired

Minimum length 1
Maximum length 1024
Pattern ^[^\u0000-\u001F\u007F]*$

fieldErrorsarray of object

Maximum items 32

Each item

3 properties

codestringRequired

Minimum length 1
Maximum length 128
Pattern ^[a-z][a-z0-9_]*$

messagestringRequired

Minimum length 1
Maximum length 512
Pattern ^[^\u0000-\u001F\u007F]*$

pathstringRequired

Maximum length 256

All of

Part 1

Pattern ^[^\u0000-\u001F\u007F]*$

Part 2

Pattern ^(?:|(?:\/(?:[^~]|~[01])*)+)$

instancestring

Minimum length 1
Maximum length 512
Pattern ^[^\s\u0000-\u001F\u007F]+$

limitobject

7 properties

attemptedinteger

Minimum 0
Maximum 9007199254740991

currentinteger

Minimum 0
Maximum 9007199254740991

dimensionstringRequired

One of

"active_monitors"
"beat_cadence"
"minimum_interval_seconds"
"measurements_per_observation"
"stored_observations"
"observation_retention_seconds"
"callback_endpoints"
"detector_feature"
"api_requests_per_minute"
"mcp_requests_per_minute"
"service_state"
"entitlement_lease"

limitinteger

Minimum 0
Maximum 9007199254740991

planobject

3 properties

idstringRequired

One of

"free"
"builder"
"smart"
"scale"

namestringRequired

Minimum length 1
Maximum length 64
Pattern ^[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

versionintegerRequired

Greater than 0
Maximum 9007199254740991

remediationstringRequired

One of

"upgrade_plan"
"reduce_usage"
"increase_interval"
"remove_feature"
"retry_after_refresh"
"contact_support"
"export_data"

serviceStatestring

One of

"active"
"payment_grace"
"abuse_suspended"
"canceled"
"deleting"

remediationarray of object

Maximum items 8

Each item

3 properties

codestringRequired

Minimum length 1
Maximum length 128
Pattern ^[a-z][a-z0-9_]*$

documentationstring

Minimum length 1
Maximum length 512

All of

Part 1

Pattern ^[^\s\u0000-\u001F\u007F]+$

Part 2

Pattern ^(?:\/(?!\/)|[Hh][Tt][Tt][Pp][Ss]:\/\/)

messagestringRequired

Minimum length 1
Maximum length 512
Pattern ^[^\u0000-\u001F\u007F]*$

retryablebooleanRequired

retryAfterSecondsinteger

Greater than 0
Maximum 86400

statusintegerRequired

Minimum 400
Maximum 599

titlestringRequired

Minimum length 1
Maximum length 160
Pattern ^[^\u0000-\u001F\u007F]*$

typestringRequired

Minimum length 1
Maximum length 512
Pattern ^[^\s\u0000-\u001F\u007F]+$

Operation contract

The operation exactly as it appears in the generated contract. References resolve within the OpenAPI document.

Show raw OpenAPI for getOrganizationUsage

{
  "operationId": "getOrganizationUsage",
  "parameters": [
    {
      "description": "Optional caller correlation identifier propagated to the response.",
      "in": "header",
      "name": "X-Correlation-ID",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/CorrelationId"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationUsageView"
          }
        }
      },
      "description": "Successful response",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "400": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Invalid request",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "401": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication required",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "403": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Permission denied",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "404": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Resource not found",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "429": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication rate limited",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "500": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Internal server error",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "503": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Service temporarily unavailable",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    }
  },
  "security": [
    {
      "apiCredential": []
    },
    {
      "clerkSession": []
    }
  ],
  "summary": "Read bounded organization usage, projection freshness, and entitlement alignment",
  "tags": [
    "Organization"
  ]
}