Documentation

AnalyticsMetaData
in package

Interface for retrieving metadata such as errors and metrics generated during analytics queries.

Table of Contents

$clientContextId  : string
$metrics  : array<string|int, mixed>|null
$requestId  : string
$signature  : string|null
$status  : string
$warnings  : array<string|int, mixed>
clientContextId()  : string|null
Returns the client context id associated with the query
metrics()  : array<string|int, mixed>|null
Returns metrics generated during query execution such as timings and counts.
requestId()  : string|null
Returns the identifier associated with the query
signature()  : array<string|int, mixed>|null
Returns the signature of the query
status()  : string|null
Returns the query execution status
warnings()  : array<string|int, mixed>|null
Returns any warnings generated during query execution

Properties

Methods

clientContextId()

Returns the client context id associated with the query

public clientContextId() : string|null
Tags
since
4.0.0
Return values
string|null

metrics()

Returns metrics generated during query execution such as timings and counts.

public metrics() : array<string|int, mixed>|null

If no metrics were returned then all values will be 0.

Tags
since
4.0.0
Return values
array<string|int, mixed>|null

requestId()

Returns the identifier associated with the query

public requestId() : string|null
Tags
since
4.0.0
Return values
string|null

signature()

Returns the signature of the query

public signature() : array<string|int, mixed>|null
Tags
since
4.0.0
Return values
array<string|int, mixed>|null

status()

Returns the query execution status

public status() : string|null
Tags
since
4.0.0
Return values
string|null

warnings()

Returns any warnings generated during query execution

public warnings() : array<string|int, mixed>|null
Tags
since
4.0.0
Return values
array<string|int, mixed>|null

        

Search results