GET v1/Entities/Series/

Retrieves time series data for an entity based on the PID. For a list of series types available, refer to the Series Types API.

Request Information

Parameters

Name	Type	Description	Additional information
request	EntityGetSeriesRequest	Container for the Entity Get Series Request input parameters. See parameter details below.	Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property	Type	Description
Id	String	The PID for the Entity.
SeriesType	String	The Series Type. Valid Series Types can be retrieved from the Series Type Service.
StartDate	DateTime	Start Date for the Series. The default is 1 year in the past from the current day.
EndDate	DateTime	End Date for the Series.
Currency	String	Currency for the series.
SdkVersion	String	If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "series": {
    "points": [
      {
        "x": "2026-06-05",
        "y": 1.0,
        "yFormatted": "sample string 2",
        "title": "sample string 3",
        "text": "sample string 4",
        "aggregateCount": 5
      },
      {
        "x": "2026-06-05",
        "y": 1.0,
        "yFormatted": "sample string 2",
        "title": "sample string 3",
        "text": "sample string 4",
        "aggregateCount": 5
      },
      {
        "x": "2026-06-05",
        "y": 1.0,
        "yFormatted": "sample string 2",
        "title": "sample string 3",
        "text": "sample string 4",
        "aggregateCount": 5
      }
    ],
    "baseDate": "2026-06-05T14:37:14.5874354+00:00",
    "name": "sample string 2",
    "hasData": false,
    "xAxisName": "sample string 4",
    "yAxisName": "sample string 5",
    "zAxisName": "sample string 6",
    "cAxisName": "sample string 7",
    "requiresSubscription": false,
    "currency": "sample string 9",
    "scale": 10
  },
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "id": "sample string 1",
    "seriesType": "sample string 2",
    "startDate": 1780670234587,
    "endDate": 1780670234587,
    "currency": "sample string 5",
    "sdkVersion": "sample string 6"
  }
}

application/xml, text/xml

Sample:

<EntityGetSeriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 6</SdkVersion>
    <Currency>sample string 5</Currency>
    <EndDate>2026-06-05T14:37:14.5874354+00:00</EndDate>
    <Id>sample string 1</Id>
    <SeriesType>sample string 2</SeriesType>
    <StartDate>2026-06-05T14:37:14.5874354+00:00</StartDate>
  </Request>
  <Series>
    <CAxisName>sample string 7</CAxisName>
    <Currency>sample string 9</Currency>
    <HasData>false</HasData>
    <Name>sample string 2</Name>
    <RequiresSubscription>false</RequiresSubscription>
    <Scale>10</Scale>
    <XAxisName>sample string 4</XAxisName>
    <YAxisName>sample string 5</YAxisName>
    <ZAxisName>sample string 6</ZAxisName>
    <BaseDate>2026-06-05T14:37:14.5874354+00:00</BaseDate>
    <Points>
      <DatePointOfNullableOfdecimal5F2dSckg>
        <AggregateCount>5</AggregateCount>
        <YFormatted>sample string 2</YFormatted>
        <text>sample string 4</text>
        <title>sample string 3</title>
        <x>2026-06-05T14:37:14.5874354+00:00</x>
        <y>1</y>
      </DatePointOfNullableOfdecimal5F2dSckg>
      <DatePointOfNullableOfdecimal5F2dSckg>
        <AggregateCount>5</AggregateCount>
        <YFormatted>sample string 2</YFormatted>
        <text>sample string 4</text>
        <title>sample string 3</title>
        <x>2026-06-05T14:37:14.5874354+00:00</x>
        <y>1</y>
      </DatePointOfNullableOfdecimal5F2dSckg>
      <DatePointOfNullableOfdecimal5F2dSckg>
        <AggregateCount>5</AggregateCount>
        <YFormatted>sample string 2</YFormatted>
        <text>sample string 4</text>
        <title>sample string 3</title>
        <x>2026-06-05T14:37:14.5874354+00:00</x>
        <y>1</y>
      </DatePointOfNullableOfdecimal5F2dSckg>
    </Points>
  </Series>
</EntityGetSeriesResponse>