Skip to main content
GET
/
projects
/
{projectId}
/
environments
/
{environmentId}
/
observability
/
http
/
breakdown
/
urls
Error
A valid request URL is required to generate request examples
{
  "_grain": 5,
  "_from": 1704067200,
  "_to": 1704153600,
  "_project_id": "abc123def456",
  "_environment_id": "main",
  "_environment_type": "production",
  "_branch_machine_name": "main-bvxea6i",
  "_breakdown_limit": 200,
  "_breakdown_top_hits": {
    "max_quantity": 15,
    "max_percentage": 98
  },
  "breakdown": {
    "kind": "url",
    "total": 396519,
    "data": [
      {
        "url": "https://example.com/api/products",
        "method": "GET",
        "impact": 15234.67,
        "average": 245.3,
        "p_50": 198.5,
        "p_96": 512.8,
        "count": 62143,
        "top_hit": true
      },
      {
        "url": "https://example.com/api/orders",
        "method": "POST",
        "impact": 6543.21,
        "average": 312.5,
        "p_50": 267.8,
        "p_96": 678.4,
        "count": 20945,
        "top_hit": false
      }
    ]
  },
  "top_hits_timeline": {
    "data": [
      {
        "timestamp": 1704067200,
        "_total_consumed": 5678.9,
        "_total_count": 1543,
        "request_size": 524288,
        "response_size": 2097152,
        "urls": {
          "GET-https://example.com/api/products": {
            "count": 1543,
            "impact": 378.45
          }
        },
        "codes": {
          "UNKNOWN": 0,
          "1XX": 0,
          "2XX": 1543,
          "3XX": 0,
          "4XX": 0,
          "5XX": 0
        }
      },
      {
        "timestamp": 1704070800
      }
    ]
  },
  "filters": {
    "max_applicable_filters": 45,
    "fields": {
      "severity": {
        "distinct_values": 3,
        "type": "string",
        "values": [
          {
            "value": "INFO",
            "count": 297
          },
          {
            "value": "ERROR",
            "count": 2
          }
        ]
      }
    }
  },
  "_methods": [
    "GET"
  ],
  "_methods_mode": "1",
  "_domains": [
    "example.com"
  ],
  "_domains_mode": "1",
  "_code_slots": [
    "2XX"
  ],
  "_code_slots_mode": "1",
  "_codes": [
    "200"
  ],
  "_codes_mode": "1",
  "_request_duration_slots": [
    "0-100"
  ],
  "_request_duration_slots_mode": "1"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string
required

The unique identifier of the Upsun project

Pattern: [a-z0-9]+
Example:

"abc123def456"

​
environmentId
string
required

The environment identifier

Pattern: .+
Example:

"main"

Query Parameters

​
from
integer<int64>
required

Start timestamp for the time range (Unix timestamp in seconds)

Example:

1704067200

​
to
integer<int64>
required

End timestamp for the time range (Unix timestamp in seconds)

Example:

1704153600

​
limit
integer

Maximum number of items to return (default: 200, max: 300)

Required range: 1 <= x <= 300
​
top_hits_count
integer

Number of top items to include in timeline (default: 15, max: 15)

Required range: 1 <= x <= 15
​
methods[]
enum<string>[]

Filter by HTTP methods. Can be specified multiple times for multiple values (e.g., ?methods[]=GET&methods[]=POST). Use methods_mode to control inclusion/exclusion behavior.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD,
OPTIONS
​
methods_mode
enum<string>

Filter mode for methods parameter. "1" (additive) includes only specified methods. "-1" (subtractive, default) excludes specified methods and includes all others.

Available options:
1,
-1
Example:

"1"

​
domains[]
string[]

Filter by request domains/hosts. Can be specified multiple times for multiple values (e.g., ?domains[]=api.example.com&domains[]=www.example.com). Use domains_mode to control inclusion/exclusion behavior.

​
domains_mode
enum<string>

Filter mode for domains parameter. "1" (additive) includes only specified domains. "-1" (subtractive, default) excludes specified domains and includes all others.

Available options:
1,
-1
Example:

"1"

​
code_slots[]
enum<string>[]

Filter by HTTP status code groups. Can be specified multiple times for multiple values (e.g., ?code_slots[]=4XX&code_slots[]=5XX). Use code_slots_mode to control inclusion/exclusion behavior.

Available options:
1XX,
2XX,
3XX,
4XX,
5XX
​
code_slots_mode
enum<string>

Filter mode for code_slots parameter. "1" (additive) includes only specified code groups. "-1" (subtractive, default) excludes specified code groups and includes all others.

Available options:
1,
-1
Example:

"1"

​
codes[]
string[]

Filter by specific HTTP status codes. Can be specified multiple times for multiple values (e.g., ?codes[]=200&codes[]=404). Use codes_mode to control inclusion/exclusion behavior.

​
codes_mode
enum<string>

Filter mode for codes parameter. "1" (additive) includes only specified codes. "-1" (subtractive, default) excludes specified codes and includes all others.

Available options:
1,
-1
Example:

"1"

​
request_duration_slots[]
enum<string>[]

Filter by response time ranges (in milliseconds). Can be specified multiple times for multiple values (e.g., ?request_duration_slots[]=0-50&request_duration_slots[]=1600+). Use request_duration_slots_mode to control inclusion/exclusion behavior.

Available options:
0-50,
50-100,
100-200,
200-400,
400-800,
800-1600,
1600+
​
request_duration_slots_mode
enum<string>

Filter mode for request_duration_slots parameter. "1" (additive) includes only specified duration ranges. "-1" (subtractive, default) excludes specified duration ranges and includes all others.

Available options:
1,
-1
Example:

"1"

Response

HTTP traffic overview retrieved successfully

​
_grain
integer
required

Data granularity in seconds

Example:

5

​
_from
integer
required

Query start timestamp

Example:

1704067200

​
_to
integer
required

Query end timestamp

Example:

1704153600

​
_project_id
string
required

Project identifier

Example:

"abc123def456"

​
_environment_id
string
required

Environment identifier

Example:

"main"

​
_environment_type
enum<string>
required

Environment type

Available options:
production,
staging,
development
Example:

"production"

​
_branch_machine_name
string
required

Branch machine name

Example:

"main-bvxea6i"

​
_breakdown_limit
integer
required

Maximum number of items returned

Example:

200

​
_breakdown_top_hits
object
required

Configuration for top hits selection

​
breakdown
object
required

URLs ranked by impact

​
top_hits_timeline
object
required

Time-series data for top hit URLs

​
filters
object
required
​
_methods
string[] | null

Applied method filter values

​
_methods_mode
enum<string> | null

Method filter mode (1=additive, -1=subtractive)

Available options:
1,
-1
​
_domains
string[] | null

Applied domain filter values

​
_domains_mode
enum<string> | null

Domain filter mode (1=additive, -1=subtractive)

Available options:
1,
-1
​
_code_slots
string[] | null

Applied code slot filter values

​
_code_slots_mode
enum<string> | null

Code slot filter mode (1=additive, -1=subtractive)

Available options:
1,
-1
​
_codes
string[] | null

Applied HTTP status code filter values

​
_codes_mode
enum<string> | null

Code filter mode (1=additive, -1=subtractive)

Available options:
1,
-1
​
_request_duration_slots
string[] | null

Applied request duration slot filter values

​
_request_duration_slots_mode
enum<string> | null

Request duration slot filter mode (1=additive, -1=subtractive)

Available options:
1,
-1
Last modified on March 25, 2026