Get Count of Samples for a TimeseriesId

Returns the number of samples for a timeseriesID and all the metrics for a given date.

URL

https://{{HOST}}/timeseries/timeseries/{timeseries_id}/date/{dt}/samplescount

Method

GET

Required IMS Scopes

  • Read
  • Write

Required ACL Permissions

  • owner
  • admin
  • readwrite
  • readonly

Versions Supported

  • 2.0 (Default)
  • 2.1

URL Path Parameters

Name Description Example Type
dt
required		 The date from which to query the samples 2018-01-01 ISO 8601 string(date)
timeseries_id
required		 Timeseries ID from which to get samples GUID string

URL Query Parameters

Name Description Example Type
v
optional		 Version of the API to use v=2.0 string

Request Header Parameters

Type Value Description
Authentication Bearer {access_token}
required		 Retrieve access token
Content-Type application/json
required		 Description

Example

Request

curl -X GET 
  'https://{{HOST}}/timeseries/timeseries/920de700-8a84-4306-aef7-2676df222c6f/date/2017-02-01/samplescount' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Cache-Control: no-cache' 
  -H 'Content-Type: application/json'

Response

[
    {
        "count": 2,
        "date": "2017-02-01",
        "timeseriesId": "920de700-8a84-4306-aef7-2676df222c6f",
        "metric": "Raw"
    }
]

Errors

Error Description
403 Forbidden

Response Body Parameters

Name Description Schema
count Description object definition
date Description object definition
timeseriesId Description object definition
metric Description object definition