Get Database Traffic - Upstash Documentation

get/redis/traffic/{id}

Request example

curl --request GET \
  --url https://api.upstash.com/v2/redis/traffic/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/redis/traffic/{id}"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.upstash.com/v2/redis/traffic/{id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);

Response

{
  "period": "1d",
  "database_region": "<string>",
  "client_network_window": "1d",
  "client_networks": [
    {
      "prefix": "203.0.113.0/24",
      "entry_region": "us-east-1",
      "provider": "<string>",
      "region": "<string>",
      "count": 1,
      "weight": 1,
      "share": 1,
      "idle_seconds": 1
    }
  ],
  "client_network_evictions": 1,
  "telemetry_window": "1d",
  "telemetry": {
    "sdks": [
      {
        "name": "@upstash/redis@1.34.0",
        "count": 1,
        "share": 1
      }
    ],
    "platforms": [
      {
        "name": "@upstash/redis@1.34.0",
        "count": 1,
        "share": 1
      }
    ],
    "runtimes": [
      {
        "name": "@upstash/redis@1.34.0",
        "count": 1,
        "share": 1
      }
    ],
    "retries": {
      "requests": 1,
      "retried": 1,
      "rate": 1
    }
  },
  "routes_window": "1d",
  "routes": [
    {
      "proxy_region": "<string>",
      "member_region": "<string>",
      "http_requests": 1,
      "tcp_connections_opened": 1,
      "tcp_connections": 1,
      "ingress_bytes": 1,
      "egress_bytes": 1,
      "errors": 1,
      "cross_region": true
    }
  ],
  "entry_regions": [
    {
      "region": "<string>",
      "share": 1
    }
  ],
  "cross_region_share": 1,
  "commands": {
    "rest_commands": 1,
    "script_commands": 1
  }
}

get/redis/traffic/{id}

Authorization

Authorizationstringheaderrequired#

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded username:password.

Path parameters

idstringrequired#

The ID of the database

Query parameters

periodstring#

The period every figure covers: 1h, 3h, 12h, 1d, 3d, 7d or 30d. Defaults to 1d.

Default: "1d"

Responses

application/json

200

Database traffic retrieved successfully

periodstring#

The period every figure covers

database_regionstring#

Primary region of the database, to compare client regions against

client_network_windowstring#

Same as period

client_networksobject[]#

Show child attributes

prefixstring#

Client network masked to /24 for IPv4 or /48 for IPv6

entry_regionstring#

Region of the Upstash proxies the network's requests came in through. A network entering through several regions has one row per region.

providerstring#

aws, gcp, cloudflare, or internet when the address is not in a published range

regionstring#

Provider region, empty for internet

countnumber#

Sampled observations. The proxies keep an hour of samples; for longer periods the hourly figures are added up over time, so compare rows rather than read it as a request count

weightnumber#

Estimated observations, an upper bound, added up over time like count

idle_secondsnumber#

Seconds since the network was last seen; for periods over 1h, the lowest value over the period

client_network_evictionsnumber#

Networks the proxies pushed out of their sampling tables. A value comparable to the observations means the list is a sample of the traffic rather than a ranking.

telemetry_windowstring#

Same as period

telemetryobject#

Show child attributes

sdksobject[]#

Show child attributes

namestring#

countnumber#

platformsobject[]#

Show child attributes

namestring#

countnumber#

runtimesobject[]#

Show child attributes

namestring#

countnumber#

retriesobject#

Show child attributes

requestsnumber#

retriednumber#

ratenumber#

routes_windowstring#

Same as period

routesobject[]#

Show child attributes

proxy_regionstring#

Region the requests entered in

member_regionstring#

Region of the replica that served them

http_requestsnumber#

tcp_connections_openednumber#

tcp_connectionsnumber#

Connections open now; every other figure covers the requested period

ingress_bytesnumber#

Bytes clients sent

egress_bytesnumber#

Bytes clients received

errorsnumber#

cross_regionboolean#

entry_regionsobject[]#

Show child attributes

regionstring#

cross_region_sharenumber#

Share of bytes served by a replica in another region than the entry region

commandsobject#

Command counts over the period, absent when the database saw none

Show child attributes

rest_commandsnumber#

Commands received over REST

script_commandsnumber#

Commands that Lua scripts ran internally

Get Database Stats Get Database Insights