Job service#

The Job Service is responsible for returning information about jobs for checklist executions.

OpenAPI file: JobService.json

Endpoints#

Get job report#

GET /jobs/v1/{jobRid}/job-report

Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.

Path parameters

jobRid string (RID) required

​

Response

jobStatus JobStatus

​

Set type to "inProgress".

inProgress InProgress

​

Set type to "completed".

completed Completed

​

Fields of Completed
result JobResult

Absent if the job’s result payload is no longer available. The job still completed successfully.

Set type to "checkJobResult".

checkJobResult CheckJobResult

​

Fields of CheckJobResult
status Status

​

Values of Status
PASS

​

FAIL

​

failures array of Range

​

Fields of Range
start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

value RangeValue

​

Set type to "double".

double number

​

Set type to "aggregation".

aggregation RangeAggregation

​

Fields of RangeAggregation
average number

​

min number

​

max number

​

standardDeviation number

​

count number

​

sum number

​

rootMeanSquare number

​

Set type to "noPointsInRange".

noPointsInRange Empty

​

areFailuresDecimated boolean

​

Set type to "computeJobResult".

computeJobResult ComputeJobResult

​

Fields of ComputeJobResult
response ComputeNodeResponse

​

Set type to "range".

range array of Range

​

Set type to "rangesSummary".

rangesSummary RangesSummary

​

Fields of RangesSummary
rangesSummary array of RangeSummary

​

Fields of RangeSummary
range Range

The range representing the minimum start and maximum end times of the ranges.

subRangeCount integer

The number of ranges found within this time range.

Set type to "rangeValue".

rangeValue Range

​

Set type to "numeric".

numeric NumericPlot

​

Fields of NumericPlot
timestamps array of Timestamp

​

values array of number

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "timestampAndId".

timestampAndId TimestampAndId

​

Fields of TimestampAndId
timestamp Timestamp

​

id string (UUID)

​

Set type to "bucketedNumeric".

bucketedNumeric BucketedNumericPlot

​

Fields of BucketedNumericPlot
timestamps array of Timestamp

The end of the bucket, exclusive.

buckets array of NumericBucket

​

Fields of NumericBucket
min number

​

max number

​

mean number

​

count integer (int64)

​

variance number

The population variance of the bucket. If the bucket has only one value, this will be 0.

firstPoint NumericPoint

​

Fields of NumericPoint
timestamp Timestamp

​

value number

​

lastPoint NumericPoint

Will be empty if the bucket only has a single point.

aggregations map of string to number

Additional per-bucket aggregations that have no dedicated field above, keyed by the output column name requested via numericAggregations or numericOutputFieldsV2 (e.g. sum, standardDeviation, rootMeanSquare, p50). Empty when no additional aggregations were requested.

Set type to "numericPoint".

numericPoint NumericPoint

​

Set type to "singlePoint".

singlePoint SinglePoint

​

Fields of SinglePoint
timestamp Timestamp

​

value Value

​

Set type to "stringValue".

stringValue string

​

Set type to "float64Value".

float64Value number

​

Set type to "int64Value".

int64Value string

​

Set type to "arrayValue".

arrayValue array of Value

​

Set type to "structValue".

structValue any JSON value

A JSON representation of the struct

precisionLoss boolean

Returns true if the result required downcasting to a type with less precision, for example if the input series was Int64 and the result is a Float64.

Set type to "arrowNumeric".

arrowNumeric ArrowPlot

​

Fields of ArrowPlot
arrowBinary string (base64)

The raw binary containing an Arrow IPC stream.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "arrowBucketedNumeric".

arrowBucketedNumeric ArrowPlot

​

Set type to "enum".

enum EnumPlot

​

Fields of EnumPlot
timestamps array of Timestamp

​

values array of integer

​

categories array of string

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "enumPoint".

enumPoint EnumPoint

​

Fields of EnumPoint
timestamp Timestamp

​

value string

​

Set type to "bucketedEnum".

bucketedEnum BucketedEnumPlot

​

Fields of BucketedEnumPlot
timestamps array of Timestamp

The end of the bucket, exclusive.

buckets array of EnumBucket

​

Fields of EnumBucket
histogram map of string to integer (int64)

The map of values within the bucket to their frequency.

firstPoint CompactEnumPoint

​

Fields of CompactEnumPoint
timestamp Timestamp

​

value integer

​

lastPoint CompactEnumPoint

Will be empty if the bucket only has a single point.

categories array of string

​

Set type to "arrowEnum".

arrowEnum ArrowPlot

​

Set type to "arrowBucketedEnum".

arrowBucketedEnum ArrowPlot

​

Set type to "pagedLog".

pagedLog PagedLogPlot

​

Fields of PagedLogPlot
timestamps array of Timestamp

​

values array of LogValue

​

Fields of LogValue
message string

​

args map of string to string

​

id string (UUID)

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "logPoint".

logPoint LogPoint

​

Fields of LogPoint
timestamp Timestamp

​

value LogValue

​

Set type to "arrowLog".

arrowLog ArrowPlot

​

Set type to "cartesian".

cartesian CartesianPlot

​

Fields of CartesianPlot
timestamps array of Timestamp

​

xValues array of number

​

yValues array of number

​

Set type to "bucketedCartesian".

bucketedCartesian BucketedCartesianPlot

​

Fields of BucketedCartesianPlot
buckets array of CartesianBucket

​

Fields of CartesianBucket
minX number

​

maxX number

​

minY number

​

maxY number

​

minTimestamp Timestamp

​

maxTimestamp Timestamp

​

count integer (int64)

​

Set type to "bucketedCartesian3d".

bucketedCartesian3d BucketedCartesian3dPlot

​

Fields of BucketedCartesian3dPlot
buckets array of Cartesian3dBucket

​

Fields of Cartesian3dBucket
minX number deprecated

Deprecated: Switching to point-based min/maxes

maxX number deprecated

Deprecated: Switching to point-based min/maxes

meanX number

​

minY number deprecated

Deprecated: Switching to point-based min/maxes

maxY number deprecated

Deprecated: Switching to point-based min/maxes

meanY number

​

minZ number deprecated

Deprecated: Switching to point-based min/maxes

maxZ number deprecated

Deprecated: Switching to point-based min/maxes

meanZ number

​

minXPoint Point3d

​

Fields of Point3d
x number

​

y number

​

z number

​

timestamp Timestamp

​

maxXPoint Point3d

​

minYPoint Point3d

​

maxYPoint Point3d

​

minZPoint Point3d

​

maxZPoint Point3d

​

minTimestamp Timestamp

​

maxTimestamp Timestamp

​

count integer (int64)

​

Set type to "frequencyDomain".

frequencyDomain FrequencyDomainPlot

​

Fields of FrequencyDomainPlot
frequencies array of number

​

amplitudes array of number

​

Set type to "frequencyDomainV2".

frequencyDomainV2 FrequencyDomainPlotV2

​

Set type to "real".

real FrequencyDomainPlot

​

Set type to "complex".

complex FrequencyDomainPlotComplex

​

Fields of FrequencyDomainPlotComplex
frequencies array of number

​

real array of number

​

imaginary array of number

​

Set type to "magnitudeAndPhase".

magnitudeAndPhase FrequencyDomainPlotMagnitudeAndPhase

​

Fields of FrequencyDomainPlotMagnitudeAndPhase
frequencies array of number

​

magnitudes array of number

​

phases array of number

​

Set type to "spectrogram".

spectrogram SpectrogramPlot

​

Fields of SpectrogramPlot
frequencyCenters array of number

Center frequency in Hz of each column.

frequencyEdges array of number

Column boundaries in Hz, one more than frequencyCenters: column c spans frequencyEdges[c] to frequencyEdges[c + 1]. Columns may differ in width.

rows array of SpectrogramRow

​

Fields of SpectrogramRow
start Timestamp

Start of the time span this row covers.

end Timestamp

End of the time span this row covers.

values array of number

One value per column

Set type to "bucketedFrequencyDomain".

bucketedFrequencyDomain BucketedFrequencyDomainPlot

​

Fields of BucketedFrequencyDomainPlot
buckets array of FrequencyBucket

​

Fields of FrequencyBucket
frequencyStart number

The start frequency of this bucket (inclusive).

frequencyEnd number

The end frequency of this bucket (exclusive).

frequencyCenter number

The center frequency of this bucket.

minAmplitude number

The minimum amplitude value in this bucket.

maxAmplitude number

The maximum amplitude value in this bucket.

meanAmplitude number

The mean amplitude value in this bucket.

count integer (int64)

The number of original frequency points that were aggregated into this bucket.

firstPoint FrequencyPoint

The first point (lowest frequency) in this bucket.

Fields of FrequencyPoint
frequency number

​

amplitude number

​

lastPoint FrequencyPoint

The last point (highest frequency) in this bucket. Will be empty if the bucket only has a single point.

Set type to "numericHistogram".

numericHistogram NumericHistogramPlot

​

Fields of NumericHistogramPlot
buckets array of NumericHistogramBucket

​

Fields of NumericHistogramBucket
lowerBound number

The lower bound of the bucket, inclusive

upperBound number

The upper bound of the bucket, exclusive

countsByChannel map of VariableName to HistogramChannelCount

​

Fields of HistogramChannelCount
count integer (int64)

​

buckets map of VariableName to HistogramChannelCount deprecated

Deprecated: Use countsByChannel instead

Set type to "enumHistogram".

enumHistogram EnumHistogramPlot

​

Fields of EnumHistogramPlot
buckets array of EnumHistogramBucket

​

Fields of EnumHistogramBucket
value string

The value of the enum as a string

countsByChannel map of VariableName to HistogramChannelCount

​

Set type to "curveFit".

curveFit CurveFitResult

Deprecated: use curveFitV2 (CurveFitResultV2) instead. Returned only for deprecated CurveFit requests.

Fields of CurveFitResult
r2 number

R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line).

mae number

Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values.

mse number

Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values.

rmse number

Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values.

maxAbsoluteError number

Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values.

sampleCount integer

The number of data points used in the curve fitting calculation.

curveResultDetails CurveResultDetails

Description of the fit curve.

Set type to "exponential".

exponential ExponentialResultDetails

​

Fields of ExponentialResultDetails
a number

​

b number

​

Set type to "logarithmic".

logarithmic LogarithmicResultDetails

​

Fields of LogarithmicResultDetails
a number

​

b number

​

Set type to "polynomial".

polynomial PolynomialResultDetails

​

Fields of PolynomialResultDetails
a array of number

​

Set type to "power".

power PowerResultDetails

​

Fields of PowerResultDetails
a number

​

b number

​

Set type to "curveFitV2".

curveFitV2 CurveFitResultV2

​

Fields of CurveFitResultV2
r2 number

R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line).

mae number

Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values.

mse number

Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values.

rmse number

Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values.

maxAbsoluteError number

Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values.

sampleCount integer

The number of data points used in the curve fitting calculation.

curveResultDetails CurveResultDetailsV2

Description of the fit curve.

Set type to "exponential".

exponential ExponentialResultDetails

​

Set type to "logarithmic".

logarithmic LogarithmicResultDetails

​

Set type to "polynomial".

polynomial PolynomialResultDetails

​

Set type to "power".

power PowerResultDetails

​

Set type to "custom".

custom CustomCurveResultDetails

​

Fields of CustomCurveResultDetails
parameters map of string to number

Optimized parameter values produced by the curve fit. Keys match the parameter names provided in the request.

converged boolean

Whether the optimizer converged to a solution within its iteration limit. When false, the returned parameters are the best estimate found before the iteration cap was reached and did not satisfy the solver’s convergence tolerances.

iterations integer

Number of iterations the solver completed.

Set type to "grouped".

grouped GroupedComputeNodeResponses

​

Fields of GroupedComputeNodeResponses
responses array of GroupedComputeNodeResponse

​

Fields of GroupedComputeNodeResponse
grouping Grouping

​

Set type to "tagsWithValues".

tagsWithValues map of string to string

A grouping identified by a specific instantiation of tag keys and values.

response ComputeNodeResponse

​

Set type to "array".

array ArrowArrayPlot

​

Set type to "bucketedNumeric".

bucketedNumeric BucketedNumericArrayPlot

​

Fields of BucketedNumericArrayPlot
arrowBinary string (base64)

The raw binary containing Arrow IPC stream for a bucketed N-dimensional numeric array plot.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

Set type to "bucketedEnum".

bucketedEnum BucketedEnumArrayPlot

​

Fields of BucketedEnumArrayPlot
arrowBinary string (base64)

The raw binary containing Arrow IPC stream for a bucketed N-dimensional enum array plot.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

Set type to "bucketedStruct".

bucketedStruct ArrowPlot

​

Set type to "arrowStruct".

arrowStruct ArrowPlot

​

Set type to "fullResolution".

fullResolution ArrowPlot

​

Set type to "arrowBucketedMultivariate".

arrowBucketedMultivariate ArrowPlot

​

Set type to "multivariate".

multivariate BucketedMultivariatePlot

​

Fields of BucketedMultivariatePlot
buckets array of MultivariateBucket

​

Fields of MultivariateBucket
timestamp Timestamp

​

values array of Value

Values for each input series in the bucket.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

executionEndTime string (date-time)

​

Set type to "udfCompilationJobResult".

udfCompilationJobResult UdfCompilationJobResult

​

Fields of UdfCompilationJobResult
artifactHandle S3Handle

​

Fields of S3Handle
bucket string

​

key string

​

manifestHandle S3Handle

​

compileKey string

​

executionStartTime string (date-time)

​

executionEndTime string (date-time)

​

Set type to "failed".

failed Failed

​

Fields of Failed
failureMessage string

​

executionStartTime string (date-time)

​

executionEndTime string (date-time)

​

Set type to "cancelled".

cancelled Cancelled

​

Fields of Cancelled
executionStartTime string (date-time)

​

executionEndTime string (date-time)

​

jobRid string (RID)

​

submittedAt string (date-time)

​

Request

curl "https://api.gov.nominal.io/api/jobs/v1/<job rid>/job-report" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/jobs/v1/<job rid>/job-report",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/jobs/v1/<job rid>/job-report",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/jobs/v1/<job rid>/job-report",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "jobStatus": {
    "type": "inProgress",
    "inProgress": {}
  },
  "jobRid": "<job rid>",
  "submittedAt": "2026-01-01T00:00:00Z"
}

Batch get job reports#

POST /jobs/v1/batch-get-job-reports

Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from the response.

Body

jobRids array of string (RID)

​

Response

jobRidsToJobReports map of JobRid to JobReport

​

Fields of JobReport
jobStatus JobStatus

​

Set type to "inProgress".

inProgress InProgress

​

Set type to "completed".

completed Completed

​

Fields of Completed
result JobResult

Absent if the job’s result payload is no longer available. The job still completed successfully.

Set type to "checkJobResult".

checkJobResult CheckJobResult

​

Fields of CheckJobResult
status Status

​

Values of Status
PASS

​

FAIL

​

failures array of Range

​

Fields of Range
start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

value RangeValue

​

Set type to "double".

double number

​

Set type to "aggregation".

aggregation RangeAggregation

​

Fields of RangeAggregation
average number

​

min number

​

max number

​

standardDeviation number

​

count number

​

sum number

​

rootMeanSquare number

​

Set type to "noPointsInRange".

noPointsInRange Empty

​

areFailuresDecimated boolean

​

Set type to "computeJobResult".

computeJobResult ComputeJobResult

​

Fields of ComputeJobResult
response ComputeNodeResponse

​

Set type to "range".

range array of Range

​

Set type to "rangesSummary".

rangesSummary RangesSummary

​

Fields of RangesSummary
rangesSummary array of RangeSummary

​

Fields of RangeSummary
range Range

The range representing the minimum start and maximum end times of the ranges.

subRangeCount integer

The number of ranges found within this time range.

Set type to "rangeValue".

rangeValue Range

​

Set type to "numeric".

numeric NumericPlot

​

Fields of NumericPlot
timestamps array of Timestamp

​

values array of number

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "timestampAndId".

timestampAndId TimestampAndId

​

Fields of TimestampAndId
timestamp Timestamp

Request

curl -X POST "https://api.gov.nominal.io/api/jobs/v1/batch-get-job-reports" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "jobRids": [
    "<job rid>"
  ]
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/jobs/v1/batch-get-job-reports",
    headers={"Authorization": "Bearer <api key>"},
    json={"jobRids": ["<job rid>"]},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/jobs/v1/batch-get-job-reports",
    headers={"Authorization": "Bearer <api key>"},
    json={"jobRids": ["<job rid>"]},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/jobs/v1/batch-get-job-reports",
            headers={"Authorization": "Bearer <api key>"},
            json={"jobRids": ["<job rid>"]},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "jobRidsToJobReports": {
    "<key>": {
      "jobStatus": {
        "type": "inProgress",
        "inProgress": {}
      },
      "jobRid": "<job rid>",
      "submittedAt": "2026-01-01T00:00:00Z"
    }
  }
}

Cancel job#

POST /jobs/v1/{jobRid}/cancel

Cancels an in-progress job. For compute jobs this also stops the running computation. A no-op for jobs already in a terminal state. Returns the resulting report.

Path parameters

jobRid string (RID) required

​

Response

jobStatus JobStatus

​

Set type to "inProgress".

inProgress InProgress

​

Set type to "completed".

completed Completed

​

Fields of Completed
result JobResult

Absent if the job’s result payload is no longer available. The job still completed successfully.

Set type to "checkJobResult".

checkJobResult CheckJobResult

​

Fields of CheckJobResult
status Status

​

Values of Status
PASS

​

FAIL

​

failures array of Range

​

Fields of Range
start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

value RangeValue

​

Set type to "double".

double number

​

Set type to "aggregation".

aggregation RangeAggregation

​

Fields of RangeAggregation
average number

​

min number

​

max number

​

standardDeviation number

​

count number

​

sum number

​

rootMeanSquare number

​

Set type to "noPointsInRange".

noPointsInRange Empty

​

areFailuresDecimated boolean

​

Set type to "computeJobResult".

computeJobResult ComputeJobResult

​

Fields of ComputeJobResult
response ComputeNodeResponse

​

Set type to "range".

range array of Range

​

Set type to "rangesSummary".

rangesSummary RangesSummary

​

Fields of RangesSummary
rangesSummary array of RangeSummary

​

Fields of RangeSummary
range Range

The range representing the minimum start and maximum end times of the ranges.

subRangeCount integer

The number of ranges found within this time range.

Set type to "rangeValue".

rangeValue Range

​

Set type to "numeric".

numeric NumericPlot

​

Fields of NumericPlot
timestamps array of Timestamp

​

values array of number

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "timestampAndId".

timestampAndId TimestampAndId

​

Fields of TimestampAndId
timestamp Timestamp

​

id string (UUID)

​

Set type to "bucketedNumeric".

bucketedNumeric BucketedNumericPlot

​

Fields of BucketedNumericPlot
timestamps array of Timestamp

The end of the bucket, exclusive.

buckets array of NumericBucket

​

Fields of NumericBucket
min number

​

max number

​

mean number

​

count integer (int64)

​

variance number

The population variance of the bucket. If the bucket has only one value, this will be 0.

firstPoint NumericPoint

​

Fields of NumericPoint
timestamp Timestamp

​

value number

​

lastPoint NumericPoint

Will be empty if the bucket only has a single point.

aggregations map of string to number

Additional per-bucket aggregations that have no dedicated field above, keyed by the output column name requested via numericAggregations or numericOutputFieldsV2 (e.g. sum, standardDeviation, rootMeanSquare, p50). Empty when no additional aggregations were requested.

Set type to "numericPoint".

numericPoint NumericPoint

​

Set type to "singlePoint".

singlePoint SinglePoint

​

Fields of SinglePoint
timestamp Timestamp

​

value Value

​

Set type to "stringValue".

stringValue string

​

Set type to "float64Value".

float64Value number

​

Set type to "int64Value".

int64Value string

​

Set type to "arrayValue".

arrayValue array of Value

​

Set type to "structValue".

structValue any JSON value

A JSON representation of the struct

precisionLoss boolean

Returns true if the result required downcasting to a type with less precision, for example if the input series was Int64 and the result is a Float64.

Set type to "arrowNumeric".

arrowNumeric ArrowPlot

​

Fields of ArrowPlot
arrowBinary string (base64)

The raw binary containing an Arrow IPC stream.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "arrowBucketedNumeric".

arrowBucketedNumeric ArrowPlot

​

Set type to "enum".

enum EnumPlot

​

Fields of EnumPlot
timestamps array of Timestamp

​

values array of integer

​

categories array of string

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "enumPoint".

enumPoint EnumPoint

​

Fields of EnumPoint
timestamp Timestamp

​

value string

​

Set type to "bucketedEnum".

bucketedEnum BucketedEnumPlot

​

Fields of BucketedEnumPlot
timestamps array of Timestamp

The end of the bucket, exclusive.

buckets array of EnumBucket

​

Fields of EnumBucket
histogram map of string to integer (int64)

The map of values within the bucket to their frequency.

firstPoint CompactEnumPoint

​

Fields of CompactEnumPoint
timestamp Timestamp

​

value integer

​

lastPoint CompactEnumPoint

Will be empty if the bucket only has a single point.

categories array of string

​

Set type to "arrowEnum".

arrowEnum ArrowPlot

​

Set type to "arrowBucketedEnum".

arrowBucketedEnum ArrowPlot

​

Set type to "pagedLog".

pagedLog PagedLogPlot

​

Fields of PagedLogPlot
timestamps array of Timestamp

​

values array of LogValue

​

Fields of LogValue
message string

​

args map of string to string

​

id string (UUID)

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

Set type to "logPoint".

logPoint LogPoint

​

Fields of LogPoint
timestamp Timestamp

​

value LogValue

​

Set type to "arrowLog".

arrowLog ArrowPlot

​

Set type to "cartesian".

cartesian CartesianPlot

​

Fields of CartesianPlot
timestamps array of Timestamp

​

xValues array of number

​

yValues array of number

​

Set type to "bucketedCartesian".

bucketedCartesian BucketedCartesianPlot

​

Fields of BucketedCartesianPlot
buckets array of CartesianBucket

​

Fields of CartesianBucket
minX number

​

maxX number

​

minY number

​

maxY number

​

minTimestamp Timestamp

​

maxTimestamp Timestamp

​

count integer (int64)

​

Set type to "bucketedCartesian3d".

bucketedCartesian3d BucketedCartesian3dPlot

​

Fields of BucketedCartesian3dPlot
buckets array of Cartesian3dBucket

​

Fields of Cartesian3dBucket
minX number deprecated

Deprecated: Switching to point-based min/maxes

maxX number deprecated

Deprecated: Switching to point-based min/maxes

meanX number

​

minY number deprecated

Deprecated: Switching to point-based min/maxes

maxY number deprecated

Deprecated: Switching to point-based min/maxes

meanY number

​

minZ number deprecated

Deprecated: Switching to point-based min/maxes

maxZ number deprecated

Deprecated: Switching to point-based min/maxes

meanZ number

​

minXPoint Point3d

​

Fields of Point3d
x number

​

y number

​

z number

​

timestamp Timestamp

​

maxXPoint Point3d

​

minYPoint Point3d

​

maxYPoint Point3d

​

minZPoint Point3d

​

maxZPoint Point3d

​

minTimestamp Timestamp

​

maxTimestamp Timestamp

​

count integer (int64)

​

Set type to "frequencyDomain".

frequencyDomain FrequencyDomainPlot

​

Fields of FrequencyDomainPlot
frequencies array of number

​

amplitudes array of number

​

Set type to "frequencyDomainV2".

frequencyDomainV2 FrequencyDomainPlotV2

​

Set type to "real".

real FrequencyDomainPlot

​

Set type to "complex".

complex FrequencyDomainPlotComplex

​

Fields of FrequencyDomainPlotComplex
frequencies array of number

​

real array of number

​

imaginary array of number

​

Set type to "magnitudeAndPhase".

magnitudeAndPhase FrequencyDomainPlotMagnitudeAndPhase

​

Fields of FrequencyDomainPlotMagnitudeAndPhase
frequencies array of number

​

magnitudes array of number

​

phases array of number

​

Set type to "spectrogram".

spectrogram SpectrogramPlot

​

Fields of SpectrogramPlot
frequencyCenters array of number

Center frequency in Hz of each column.

frequencyEdges array of number

Column boundaries in Hz, one more than frequencyCenters: column c spans frequencyEdges[c] to frequencyEdges[c + 1]. Columns may differ in width.

rows array of SpectrogramRow

​

Fields of SpectrogramRow
start Timestamp

Start of the time span this row covers.

end Timestamp

End of the time span this row covers.

values array of number

One value per column

Set type to "bucketedFrequencyDomain".

bucketedFrequencyDomain BucketedFrequencyDomainPlot

​

Fields of BucketedFrequencyDomainPlot
buckets array of FrequencyBucket

​

Fields of FrequencyBucket
frequencyStart number

The start frequency of this bucket (inclusive).

frequencyEnd number

The end frequency of this bucket (exclusive).

frequencyCenter number

The center frequency of this bucket.

minAmplitude number

The minimum amplitude value in this bucket.

maxAmplitude number

The maximum amplitude value in this bucket.

meanAmplitude number

The mean amplitude value in this bucket.

count integer (int64)

The number of original frequency points that were aggregated into this bucket.

firstPoint FrequencyPoint

The first point (lowest frequency) in this bucket.

Fields of FrequencyPoint
frequency number

​

amplitude number

​

lastPoint FrequencyPoint

The last point (highest frequency) in this bucket. Will be empty if the bucket only has a single point.

Set type to "numericHistogram".

numericHistogram NumericHistogramPlot

​

Fields of NumericHistogramPlot
buckets array of NumericHistogramBucket

​

Fields of NumericHistogramBucket
lowerBound number

The lower bound of the bucket, inclusive

upperBound number

The upper bound of the bucket, exclusive

countsByChannel map of VariableName to HistogramChannelCount

​

Fields of HistogramChannelCount
count integer (int64)

​

buckets map of VariableName to HistogramChannelCount deprecated

Deprecated: Use countsByChannel instead

Set type to "enumHistogram".

enumHistogram EnumHistogramPlot

​

Fields of EnumHistogramPlot
buckets array of EnumHistogramBucket

​

Fields of EnumHistogramBucket
value string

The value of the enum as a string

countsByChannel map of VariableName to HistogramChannelCount

​

Set type to "curveFit".

curveFit CurveFitResult

Deprecated: use curveFitV2 (CurveFitResultV2) instead. Returned only for deprecated CurveFit requests.

Fields of CurveFitResult
r2 number

R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line).

mae number

Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values.

mse number

Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values.

rmse number

Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values.

maxAbsoluteError number

Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values.

sampleCount integer

The number of data points used in the curve fitting calculation.

curveResultDetails CurveResultDetails

Description of the fit curve.

Set type to "exponential".

exponential ExponentialResultDetails

​

Fields of ExponentialResultDetails
a number

​

b number

​

Set type to "logarithmic".

logarithmic LogarithmicResultDetails

​

Fields of LogarithmicResultDetails
a number

​

b number

​

Set type to "polynomial".

polynomial PolynomialResultDetails

​

Fields of PolynomialResultDetails
a array of number

​

Set type to "power".

power PowerResultDetails

​

Fields of PowerResultDetails
a number

​

b number

​

Set type to "curveFitV2".

curveFitV2 CurveFitResultV2

​

Fields of CurveFitResultV2
r2 number

R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line).

mae number

Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values.

mse number

Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values.

rmse number

Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values.

maxAbsoluteError number

Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values.

sampleCount integer

The number of data points used in the curve fitting calculation.

curveResultDetails CurveResultDetailsV2

Description of the fit curve.

Set type to "exponential".

exponential ExponentialResultDetails

​

Set type to "logarithmic".

logarithmic LogarithmicResultDetails

​

Set type to "polynomial".

polynomial PolynomialResultDetails

​

Set type to "power".

power PowerResultDetails

​

Set type to "custom".

custom CustomCurveResultDetails

​

Fields of CustomCurveResultDetails
parameters map of string to number

Optimized parameter values produced by the curve fit. Keys match the parameter names provided in the request.

converged boolean

Whether the optimizer converged to a solution within its iteration limit. When false, the returned parameters are the best estimate found before the iteration cap was reached and did not satisfy the solver’s convergence tolerances.

iterations integer

Number of iterations the solver completed.

Set type to "grouped".

grouped GroupedComputeNodeResponses

​

Fields of GroupedComputeNodeResponses
responses array of GroupedComputeNodeResponse

​

Fields of GroupedComputeNodeResponse
grouping Grouping

​

Set type to "tagsWithValues".

tagsWithValues map of string to string

A grouping identified by a specific instantiation of tag keys and values.

response ComputeNodeResponse

​

Set type to "array".

array ArrowArrayPlot

​

Set type to "bucketedNumeric".

bucketedNumeric BucketedNumericArrayPlot

​

Fields of BucketedNumericArrayPlot
arrowBinary string (base64)

The raw binary containing Arrow IPC stream for a bucketed N-dimensional numeric array plot.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

Set type to "bucketedEnum".

bucketedEnum BucketedEnumArrayPlot

​

Fields of BucketedEnumArrayPlot
arrowBinary string (base64)

The raw binary containing Arrow IPC stream for a bucketed N-dimensional enum array plot.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

Set type to "bucketedStruct".

bucketedStruct ArrowPlot

​

Set type to "arrowStruct".

arrowStruct ArrowPlot

​

Set type to "fullResolution".

fullResolution ArrowPlot

​

Set type to "arrowBucketedMultivariate".

arrowBucketedMultivariate ArrowPlot

​

Set type to "multivariate".

multivariate BucketedMultivariatePlot

​

Fields of BucketedMultivariatePlot
buckets array of MultivariateBucket

​

Fields of MultivariateBucket
timestamp Timestamp

​

values array of Value

Values for each input series in the bucket.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

executionEndTime string (date-time)

​

Set type to "udfCompilationJobResult".

udfCompilationJobResult UdfCompilationJobResult

​

Fields of UdfCompilationJobResult
artifactHandle S3Handle

​

Fields of S3Handle
bucket string

​

key string

​

manifestHandle S3Handle

​

compileKey string

​

executionStartTime string (date-time)

​

executionEndTime string (date-time)

​

Set type to "failed".

failed Failed

​

Fields of Failed
failureMessage string

​

executionStartTime string (date-time)

​

executionEndTime string (date-time)

​

Set type to "cancelled".

cancelled Cancelled

​

Fields of Cancelled
executionStartTime string (date-time)

​

executionEndTime string (date-time)

​

jobRid string (RID)

​

submittedAt string (date-time)

​

Request

curl -X POST "https://api.gov.nominal.io/api/jobs/v1/<job rid>/cancel" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/jobs/v1/<job rid>/cancel",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/jobs/v1/<job rid>/cancel",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/jobs/v1/<job rid>/cancel",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "jobStatus": {
    "type": "inProgress",
    "inProgress": {}
  },
  "jobRid": "<job rid>",
  "submittedAt": "2026-01-01T00:00:00Z"
}

Errors#

Errors shows how these errors are sent.

Each error’s errorName is JobService: followed by its name below.

Status

Name

Notes

404

JobNotFound

Types#

ArrowArrayPlot#

Set type to the name of one of the other fields, and set only that field.

bucketedNumeric BucketedNumericArrayPlot

​

bucketedEnum BucketedEnumArrayPlot

​

ArrowPlot#

A generic Arrow IPC plot response. Used for all Arrow-serialized plot types (numeric, bucketed numeric, enum, bucketed enum, struct, bucketed struct, full resolution, and bucketed multivariate).

arrowBinary string (base64) required

The raw binary containing an Arrow IPC stream.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

BucketedCartesian3dPlot#

buckets array of Cartesian3dBucket

​

BucketedCartesianPlot#

buckets array of CartesianBucket

​

BucketedEnumArrayPlot#

The array is flattened out into a an arrow stream of bucketed primitive results, with an extra column to indicate the index of the array that the bucket corresponds to.

arrowBinary string (base64) required

The raw binary containing Arrow IPC stream for a bucketed N-dimensional enum array plot.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

BucketedEnumPlot#

timestamps array of Timestamp

The end of the bucket, exclusive.

buckets array of EnumBucket

​

categories array of string

​

BucketedFrequencyDomainPlot#

A bucketed/decimated frequency domain plot where multiple frequency bins have been aggregated.

buckets array of FrequencyBucket

​

BucketedMultivariatePlot#

buckets array of MultivariateBucket

​

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

BucketedNumericArrayPlot#

The array is flattened out into a an arrow stream of bucketed primitive results, with an extra column to indicate the index of the array that the bucket corresponds to.

arrowBinary string (base64) required

The raw binary containing Arrow IPC stream for a bucketed N-dimensional numeric array plot.

groupByKeys array of string

This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel.

BucketedNumericPlot#

timestamps array of Timestamp

The end of the bucket, exclusive.

buckets array of NumericBucket

​

Cancelled#

The job was cancelled by an explicit cancelJob request. Distinct from Failed: cancellation is a user-initiated terminal state, not an error. executionStartTime is absent if the job was cancelled before it began executing.

executionStartTime string (date-time)

​

executionEndTime string (date-time) required

​

Cartesian3dBucket#

minX number deprecated

Deprecated: Switching to point-based min/maxes

maxX number deprecated

Deprecated: Switching to point-based min/maxes

meanX number required

​

minY number deprecated

Deprecated: Switching to point-based min/maxes

maxY number deprecated

Deprecated: Switching to point-based min/maxes

meanY number required

​

minZ number deprecated

Deprecated: Switching to point-based min/maxes

maxZ number deprecated

Deprecated: Switching to point-based min/maxes

meanZ number required

​

minXPoint Point3d required

​

maxXPoint Point3d required

​

minYPoint Point3d required

​

maxYPoint Point3d required

​

minZPoint Point3d required

​

maxZPoint Point3d required

​

minTimestamp Timestamp required

​

maxTimestamp Timestamp required

​

count integer (int64) required

​

CartesianBucket#

minX number required

​

maxX number required

​

minY number required

​

maxY number required

​

minTimestamp Timestamp required

​

maxTimestamp Timestamp required

​

count integer (int64) required

​

CartesianPlot#

timestamps array of Timestamp

​

xValues array of number

​

yValues array of number

​

CheckJobResult#

status Status required

​

failures array of Range

​

areFailuresDecimated boolean required

​

CompactEnumPoint#

timestamp Timestamp required

​

value integer required

​

Completed#

result JobResult

Absent if the job’s result payload is no longer available. The job still completed successfully.

executionStartTime string (date-time) required

​

executionEndTime string (date-time) required

​

ComputeJobResult#

The result of a compute job.

response ComputeNodeResponse required

​

executionEndTime string (date-time) required

​

ComputeNodeResponse#

Set type to the name of one of the other fields, and set only that field.

range array of Range

​

rangesSummary RangesSummary

​

rangeValue Range

​

numeric NumericPlot

​

bucketedNumeric BucketedNumericPlot

​

numericPoint NumericPoint

​

singlePoint SinglePoint

​

arrowNumeric ArrowPlot

​

arrowBucketedNumeric ArrowPlot

​

enum EnumPlot

​

enumPoint EnumPoint

​

bucketedEnum BucketedEnumPlot

​

arrowEnum ArrowPlot

​

arrowBucketedEnum ArrowPlot

​

pagedLog PagedLogPlot

​

logPoint LogPoint

​

arrowLog ArrowPlot

​

cartesian CartesianPlot

​

bucketedCartesian BucketedCartesianPlot

​

bucketedCartesian3d BucketedCartesian3dPlot

​

frequencyDomain FrequencyDomainPlot

​

frequencyDomainV2 FrequencyDomainPlotV2

​

spectrogram SpectrogramPlot

​

bucketedFrequencyDomain BucketedFrequencyDomainPlot

​

numericHistogram NumericHistogramPlot

​

enumHistogram EnumHistogramPlot

​

curveFit CurveFitResult

Deprecated: use curveFitV2 (CurveFitResultV2) instead. Returned only for deprecated CurveFit requests.

curveFitV2 CurveFitResultV2

​

grouped GroupedComputeNodeResponses

​

array ArrowArrayPlot

​

bucketedStruct ArrowPlot

​

arrowStruct ArrowPlot

​

fullResolution ArrowPlot

​

arrowBucketedMultivariate ArrowPlot

​

multivariate BucketedMultivariatePlot

​

CurveFitResult#

r2 number required

R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line).

mae number required

Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values.

mse number required

Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values.

rmse number required

Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values.

maxAbsoluteError number required

Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values.

sampleCount integer required

The number of data points used in the curve fitting calculation.

curveResultDetails CurveResultDetails required

Description of the fit curve.

CurveFitResultV2#

r2 number required

R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line).

mae number required

Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values.

mse number required

Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values.

rmse number required

Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values.

maxAbsoluteError number required

Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values.

sampleCount integer required

The number of data points used in the curve fitting calculation.

curveResultDetails CurveResultDetailsV2 required

Description of the fit curve.

CurveResultDetails#

Set type to the name of one of the other fields, and set only that field.

exponential ExponentialResultDetails

​

logarithmic LogarithmicResultDetails

​

polynomial PolynomialResultDetails

​

power PowerResultDetails

​

CurveResultDetailsV2#

Set type to the name of one of the other fields, and set only that field.

exponential ExponentialResultDetails

​

logarithmic LogarithmicResultDetails

​

polynomial PolynomialResultDetails

​

power PowerResultDetails

​

custom CustomCurveResultDetails

​

CustomCurveResultDetails#

The result of fitting a custom curve, containing the optimized values for each named parameter.

parameters map of string to number

Optimized parameter values produced by the curve fit. Keys match the parameter names provided in the request.

converged boolean required

Whether the optimizer converged to a solution within its iteration limit. When false, the returned parameters are the best estimate found before the iteration cap was reached and did not satisfy the solver’s convergence tolerances.

iterations integer required

Number of iterations the solver completed.

Empty#

An empty JSON object, {}.

EnumBucket#

histogram map of string to integer (int64)

The map of values within the bucket to their frequency.

firstPoint CompactEnumPoint required

​

lastPoint CompactEnumPoint

Will be empty if the bucket only has a single point.

EnumHistogramBucket#

A bucket in an enum histogram representing all the counts for a specific enumerated value, across all input series.

value string required

The value of the enum as a string

countsByChannel map of VariableName to HistogramChannelCount

​

EnumHistogramPlot#

buckets array of EnumHistogramBucket

​

EnumPlot#

timestamps array of Timestamp

​

values array of integer

​

categories array of string

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

EnumPoint#

timestamp Timestamp required

​

value string required

​

ExponentialResultDetails#

y = a * e^(b * x)

a number required

​

b number required

​

Failed#

failureMessage string

​

executionStartTime string (date-time)

​

executionEndTime string (date-time) required

​

FrequencyBucket#

A single bucket in a bucketed frequency domain plot.

frequencyStart number required

The start frequency of this bucket (inclusive).

frequencyEnd number required

The end frequency of this bucket (exclusive).

frequencyCenter number required

The center frequency of this bucket.

minAmplitude number required

The minimum amplitude value in this bucket.

maxAmplitude number required

The maximum amplitude value in this bucket.

meanAmplitude number required

The mean amplitude value in this bucket.

count integer (int64) required

The number of original frequency points that were aggregated into this bucket.

firstPoint FrequencyPoint required

The first point (lowest frequency) in this bucket.

lastPoint FrequencyPoint

The last point (highest frequency) in this bucket. Will be empty if the bucket only has a single point.

FrequencyDomainPlot#

frequencies array of number

​

amplitudes array of number

​

FrequencyDomainPlotComplex#

frequencies array of number

​

real array of number

​

imaginary array of number

​

FrequencyDomainPlotMagnitudeAndPhase#

frequencies array of number

​

magnitudes array of number

​

phases array of number

​

FrequencyDomainPlotV2#

Set type to the name of one of the other fields, and set only that field.

real FrequencyDomainPlot

​

complex FrequencyDomainPlotComplex

​

magnitudeAndPhase FrequencyDomainPlotMagnitudeAndPhase

​

FrequencyPoint#

A single point in a frequency domain plot.

frequency number required

​

amplitude number required

​

GroupedComputeNodeResponse#

grouping Grouping required

​

response ComputeNodeResponse required

​

GroupedComputeNodeResponses#

Contains a ComputeNodeResponse for each applicable grouping along with metadata describing the grouping. All the contained ComputeNodeResponses are guaranteed to be of the same type.

responses array of GroupedComputeNodeResponse

​

Grouping#

Set type to the name of one of the other fields, and set only that field.

tagsWithValues map of string to string

A grouping identified by a specific instantiation of tag keys and values.

HistogramChannelCount#

The count of the value in the bucket for the specific channel.

count integer (int64) required

​

InProgress#

An empty JSON object, {}.

JobReport#

jobStatus JobStatus required

​

jobRid string (RID) required

​

submittedAt string (date-time) required

​

JobResult#

Set type to the name of one of the other fields, and set only that field.

checkJobResult CheckJobResult

​

computeJobResult ComputeJobResult

​

udfCompilationJobResult UdfCompilationJobResult

​

JobStatus#

Set type to the name of one of the other fields, and set only that field.

inProgress InProgress

​

completed Completed

​

failed Failed

​

cancelled Cancelled

​

LogarithmicResultDetails#

y = a * ln(x) + b

a number required

​

b number required

​

LogPoint#

timestamp Timestamp required

​

value LogValue required

​

LogValue#

message string required

​

args map of string to string

​

id string (UUID) required

​

MultivariateBucket#

timestamp Timestamp required

​

values array of Value

Values for each input series in the bucket.

NumericBucket#

min number

​

max number

​

mean number

​

count integer (int64)

​

variance number

The population variance of the bucket. If the bucket has only one value, this will be 0.

firstPoint NumericPoint

​

lastPoint NumericPoint

Will be empty if the bucket only has a single point.

aggregations map of string to number

Additional per-bucket aggregations that have no dedicated field above, keyed by the output column name requested via numericAggregations or numericOutputFieldsV2 (e.g. sum, standardDeviation, rootMeanSquare, p50). Empty when no additional aggregations were requested.

NumericHistogramBucket#

A bucket in a numeric histogram representing a range of values, and the counts of values in that range across all input series.

lowerBound number required

The lower bound of the bucket, inclusive

upperBound number required

The upper bound of the bucket, exclusive

countsByChannel map of VariableName to HistogramChannelCount

​

buckets map of VariableName to HistogramChannelCount deprecated

Deprecated: Use countsByChannel instead

NumericHistogramPlot#

buckets array of NumericHistogramBucket

​

NumericPlot#

timestamps array of Timestamp

​

values array of number

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

NumericPoint#

timestamp Timestamp required

​

value number required

​

PagedLogPlot#

timestamps array of Timestamp

​

values array of LogValue

​

nextPageToken PageToken

Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as pageToken and keep the pageSize sign unchanged. Returned only when this response contains exactly abs(pageSize) points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction.

PageToken#

Set type to the name of one of the other fields, and set only that field.

timestampAndId TimestampAndId

​

Point3d#

x number required

​

y number required

​

z number required

​

timestamp Timestamp required

​

PolynomialResultDetails#

y = sum( a_i * x^i ) for i in 0…len(a)

a array of number

​

PowerResultDetails#

y = a * x^b

a number required

​

b number required

​

Range#

The end represents the first timestamp that does not belong to the range. If absent, there is no known end to the range.

start Timestamp

​

end Timestamp

​

value RangeValue

​

RangeAggregation#

An aggregation value representing combined aggregation metrics for data over a range.

average number required

​

min number required

​

max number required

​

standardDeviation number required

​

count number required

​

sum number required

​

rootMeanSquare number

​

RangesSummary#

A summary of the ranges returned from a SummarizeRanges request. Returned when the number of ranges found is above a threshold.

rangesSummary array of RangeSummary

​

RangeSummary#

Summary of a set of ranges

range Range required

The range representing the minimum start and maximum end times of the ranges.

subRangeCount integer required

The number of ranges found within this time range.

RangeValue#

A value attached to a range. If there are no relevant data points in the range, this will be noPointsInRange for the range; otherwise, an Aggregation will be returned if this is produced by getting multiple aggregation values over a range (i.e. aggregating for all metrics over a range), and will be a double otherwise for singular values (i.e. aggregating for just the sum of data values over a range).

Set type to the name of one of the other fields, and set only that field.

double number

​

aggregation RangeAggregation

​

noPointsInRange Empty

​

S3Handle#

bucket string required

​

key string required

​

SinglePoint#

Return type representing a single point value.

timestamp Timestamp required

​

value Value required

​

precisionLoss boolean required

Returns true if the result required downcasting to a type with less precision, for example if the input series was Int64 and the result is a Float64.

SpectrogramPlot#

Values on a time-frequency grid. Columns are frequency buckets and rows are the time buckets that hold data, in ascending time.

frequencyCenters array of number

Center frequency in Hz of each column.

frequencyEdges array of number

Column boundaries in Hz, one more than frequencyCenters: column c spans frequencyEdges[c] to frequencyEdges[c + 1]. Columns may differ in width.

rows array of SpectrogramRow

​

SpectrogramRow#

start Timestamp required

Start of the time span this row covers.

end Timestamp required

End of the time span this row covers.

values array of number

One value per column

Status#

PASS

​

FAIL

​

Timestamp#

Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants in proto APIs.

This legacy nanosecond precision timestamp type is represented by an epoch time in seconds and a nanosecond offset. The nanosecond offset is from the start of the epoch second, so must be less than 1 billion.

seconds integer (int64) required

​

nanos integer (int64) required

​

TimestampAndId#

timestamp Timestamp required

​

id string (UUID)

​

UdfCompilationJobResult#

artifactHandle S3Handle required

​

manifestHandle S3Handle required

​

compileKey string required

​

Value#

A single value. The type is dictated by the returned variant

Set type to the name of one of the other fields, and set only that field.

stringValue string

​

float64Value number

​

int64Value string

​

arrayValue array of Value

​

structValue any JSON value

A JSON representation of the struct

Page design based on Scalar, MIT License.