Query API - HTTP Spec

This is an early access enterprise service. Send an inquiry to Unacast about your interest.

All endpoints

query_service

Method	URI	Name	Summary
GET	/v1/catalogs/{catalogId}/metrics/{metricId}/values	query service search metric values	Search for metric values is meant for lower-latency access to data it will for not guarantee providing more than 100000 results for any single query

Paths

Search for metric values is meant for lower-latency access to data

it will for not guarantee providing more than 100000 results for any single query (QueryService_SearchMetricValues)

GET /v1/catalogs/{catalogId}/metrics/{metricId}/values

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
catalogId	path	string	string		✓
metricId	path	string	string		✓
billingContext	query	string	string
featureFilter	query	[]string	[]string	multi			List of features by ID to limit the search to
observationPeriodFilter.end.day	query	int32 (formatted integer)	int32
observationPeriodFilter.end.month	query	int32 (formatted integer)	int32
observationPeriodFilter.end.year	query	int32 (formatted integer)	int32
observationPeriodFilter.start.day	query	int32 (formatted integer)	int32
observationPeriodFilter.start.month	query	int32 (formatted integer)	int32
observationPeriodFilter.start.year	query	int32 (formatted integer)	int32
pageSize	query	int32 (formatted integer)	int32
pageToken	query	string	string
relatedFeatureFilter	query	[]string	[]string	multi			List of related-features by ID to limit the search to

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema
default		An unexpected error response.		schema

Responses

200 - A successful response.

Status: OK

Schema

V1SearchMetricValuesResponse

Default Response

An unexpected error response.

Schema

RPCStatus

Models

MetricValueValue

Properties

Name	Type	Go type	Required	Default	Description	Example
category	string	string
count	int64 (formatted string)	string
name	string	string
number	float (formatted number)	float32
unit	string	string

catalogv1DateRange

Properties

Name	Type	Go type	Required	Default	Description	Example
endDate	string	string
startDate	string	string

protobufAny

Properties

Name	Type	Go type	Required	Default	Description	Example
@type	string	string

rpcStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
code	int32 (formatted integer)	int32
details	[][ProtobufAny](#protobuf-any)	[]*ProtobufAny
message	string	string

unatypeDate

Properties

Name	Type	Go type	Required	Default	Description	Example
day	int32 (formatted integer)	int32
month	int32 (formatted integer)	int32
year	int32 (formatted integer)	int32

v1AddressComponentFilter

Properties

Name	Type	Go type	Required	Default	Description	Example
component	string	string
values	[]string	[]string

v1AddressComponentValue

Properties

Name	Type	Go type	Required	Default	Description	Example
component	string	string
displayName	string	string
shortName	string	string
value	string	string

v1DimensionFilter

Properties

Name	Type	Go type	Required	Default	Description	Example
dimensionId	string	string
values	[]string	[]string

v1DimensionValue

Properties

Name	Type	Go type	Required	Default	Description	Example
dimensionId	string	string
displayName	string	string
value	string	string

v1Feature

Properties

Name	Type	Go type	Required	Default	Description	Example
addressComponents	[][V1AddressComponentValue](#v1-address-component-value)	[]*V1AddressComponentValue
cameIntoExistence	string	string
ceasedToExist	string	string
featureId	string	string
geo	string	string
layerId	string	string
name	string	string
point	string	string
polygon	string	string

v1MetricReport

Properties

Name	Type	Go type	Required	Default	Description	Example
observationPeriod	V1Period	V1Period

v1MetricValue

Properties

Name	Type	Go type	Required	Default	Description	Example
dimensions	[][V1DimensionValue](#v1-dimension-value)	[]*V1DimensionValue
mapFeatureV2	V1Feature	V1Feature
metricId	string	string
observationPeriod	V1Period	V1Period
relatedMapFeature	V1Feature	V1Feature
supportingValues	[][MetricValueValue](#metric-value-value)	[]*MetricValueValue
value	MetricValueValue	MetricValueValue
values	[][MetricValueValue](#metric-value-value)	[]*MetricValueValue

v1Period

Properties

Name	Type	Go type	Required	Default	Description	Example
end	UnatypeDate	UnatypeDate
start	UnatypeDate	UnatypeDate

v1QueryMetricFilters

Properties

Name	Type	Go type	Required	Default	Description	Example
addressComponentFilters	[][V1AddressComponentFilter](#v1-address-component-filter)	[]*V1AddressComponentFilter
dimensionFilters	[][V1DimensionFilter](#v1-dimension-filter)	[]*V1DimensionFilter
featureFilters	[]string	[]string
periodFilters	[][V1Period](#v1-period)	[]*V1Period
relatedAddressComponentFilters	[][V1AddressComponentFilter](#v1-address-component-filter)	[]*V1AddressComponentFilter
relatedFeatureFilters	[]string	[]string
valueFilters	[][V1ValueFilter](#v1-value-filter)	[]*V1ValueFilter

v1SearchAddressComponentValuesResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
addressComponentValues	[][V1AddressComponentValue](#v1-address-component-value)	[]*V1AddressComponentValue
nextPageToken	string	string
totalSize	int32 (formatted integer)	int32

v1SearchDimensionValuesResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
dimensionValues	[][V1DimensionValue](#v1-dimension-value)	[]*V1DimensionValue
nextPageToken	string	string
totalSize	int32 (formatted integer)	int32

v1SearchFeatureBoundingBox

Properties

Name	Type	Go type	Required	Default	Description	Example
east	double (formatted number)	float64
north	double (formatted number)	float64
south	double (formatted number)	float64
west	double (formatted number)	float64

v1SearchLayerFeaturesResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
features	[][V1Feature](#v1-feature)	[]*V1Feature
nextPageToken	string	string
queryScores	[]float (formatted number)	[]float32
totalSize	int32 (formatted integer)	int32

v1SearchMetricReportResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
appliedFilters	V1QueryMetricFilters	V1QueryMetricFilters
report	V1MetricReport	V1MetricReport

v1SearchMetricValuesResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
appliedFilters	V1QueryMetricFilters	V1QueryMetricFilters
nextPageToken	string	string
totalSize	int32 (formatted integer)	int32
values	[][V1MetricValue](#v1-metric-value)	[]*V1MetricValue

v1ValueFilter

Properties

Name	Type	Go type	Required	Default	Description	Example
numericValue	float (formatted number)	float32
operator	V1ValueFilterOperator	V1ValueFilterOperator
valueName	string	string

v1ValueFilterOperator

Name	Type	Go type	Default	Description	Example
v1ValueFilterOperator	string	string	"VALUE_FILTER_UNSPECIFIED"