UPupstash
redis

Get Database Traffic

Changed on

This endpoint reports where a database's traffic comes from over a period. Available for databases on a Pro plan or with the Production Pack.

get/redis/traffic/{id}

Request

Path parameters

idstring required

The ID of the database

Query parameters

periodstring

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

Response

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_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

routes_windowstring

Same as period

cross_region_sharenumber

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

Example response

{
  "period": "1d",
  "client_network_window": "1d",
  "client_networks": [
    {
      "prefix": "203.0.113.0/24",
      "entry_region": "us-east-1"
    }
  ],
  "telemetry_window": "1d",
  "telemetry": {
    "sdks": [
      {
        "name": "@upstash/redis@1.34.0"
      }
    ],
    "platforms": [
      {
        "name": "@upstash/redis@1.34.0"
      }
    ],
    "runtimes": [
      {
        "name": "@upstash/redis@1.34.0"
      }
    ]
  },
  "routes_window": "1d"
}

Changes