Get server cache metrics - Upsun Developer

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

integer<int64>

required

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

Example:

1704153600

grain

integer

Granularity of data points in seconds. Auto-calculated if omitted.

Example:

10

contexts[]

enum<string>[]

Filter by execution contexts. Defaults to ["web"] with additive mode when neither contexts nor contexts_mode is specified.

Available options:

web,

cli

contexts_mode

enum<string>

Filter mode for contexts parameter. "1" (additive, default) includes only specified contexts. "-1" (subtractive) excludes specified contexts and includes all others. When neither contexts nor contexts_mode is specified, defaults to "1" (additive) with contexts=["web"].

Available options:

1,

-1

Example:

"1"

applications[]

string[]

Filter by application names

applications_mode

enum<string>

Filter mode for applications parameter. "1" (additive) includes only specified applications. "-1" (subtractive) excludes specified applications and includes all others. When omitted: defaults to "-1" if no applications values are provided; defaults to "1" (additive) if at least one applications value is provided.

Available options:

1,

-1

Example:

"1"

instances[]

string[]

Filter by instance names

instances_mode

enum<string>

Filter mode for instances parameter. "1" (additive) includes only specified instances. "-1" (subtractive) excludes specified instances and includes all others. When omitted: defaults to "-1" if no instances values are provided; defaults to "1" (additive) if at least one instances value is provided.

Available options:

1,

-1

Example:

"1"

distribution_cost

enum<string>

Cost distribution dimension for server load distribution.

Available options:

wt,

pmu

Response

PHP server cache metrics 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

_agent

string<uuid>

required

Blackfire Agent UUID

Example:

"a38f69ca-3b56-4ea6-beac-272b2568164a"

_project_id

string

required

Project identifier

Example:

"abc123def456"

_environment_id

string

required

Environment identifier

Example:

"main"

_branch_machine_name

string

required

Branch machine name

Example:

"main-bvxea6i"

_distribution_cost

enum<string>

required

Applied distribution cost dimension (wt=wall time, pmu=peak memory usage)

Available options:

wt,

pmu

data

object[]

required

Time-series cache usage metrics. Each data point contains timestamp and optional data fields. Fields are omitted for timestamps with no data - this indicates no data was received.

Show child attributes

_contexts

string[] | null

Applied context filter values

_contexts_mode

enum<string> | null

Context filter mode (additive=include only, subtractive=exclude)

Available options:

additive,

subtractive

_applications

string[] | null

Applied application filter values

_applications_mode

enum<string> | null

Application filter mode (additive=include only, subtractive=exclude)

Available options:

additive,

subtractive

_instances

string[] | null

Applied instance filter values

_instances_mode

enum<string> | null

Instance filter mode (additive=include only, subtractive=exclude)

Available options:

additive,

subtractive