Skip to content
GitmoapAPIBeta
Organizeusers
GET/user/egress-usage

The caller's own outbound-byte usage for the current hour and day

get_my_egress_usage

How many bytes you have downloaded this hour and today, each against a limit. The limits shown are the baseline every caller can rely on; downloading from an organization on a paid plan may allow more. Needs a signed-in caller.

Responses

200The caller's egress usage and limitsapplication/json
  • actor_keystringWhich budget this is: USER#{id} for a user, SA#{id} for a service account, PRT#{id} for a pipeline run. Lets a caller holding several credentials tell them apart.
  • dayEgressWindowUsageThe current day's budget, which limits sustained downloading.
    • The EgressWindowUsage schema
    • limit_bytesinteger · int640–∞The limit for this window, in bytes — reported even where the limit is not enforced, so you can see what you would be held to.
    • used_bytesinteger · int640–∞Bytes charged to this window so far.
    • windowstringThe period this covers: YYYY-MM-DDTHH for an hour, YYYY-MM-DD for a day.
  • hourEgressWindowUsageThe current hour's budget, which limits bursts.
    • The EgressWindowUsage schema
    • limit_bytesinteger · int640–∞The limit for this window, in bytes — reported even where the limit is not enforced, so you can see what you would be held to.
    • used_bytesinteger · int640–∞Bytes charged to this window so far.
    • windowstringThe period this covers: YYYY-MM-DDTHH for an hour, YYYY-MM-DD for a day.
200 exampleSynthesized example
{
"actor_key": "actor-key-3ccb",
"day": {
"limit_bytes": 19,
"used_bytes": 52,
"window": "window-0851"
},
"hour": {
"limit_bytes": 23,
"used_bytes": 72,
"window": "window-9d09"
}
}
401No authenticated callerapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-22b3",
"message": "Stream pipeline status into the run header"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-7455",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap users get-my-egress-usage

Used in these guides