Time Series API¶

The Time Series API allows you to fetch the time series data records of a charger or the connector of a charger. You can query with measurand and optionally provide phase values to query the time series data. If the duration for which to fetch the data records are not specified using the from and to parameters, only the previous day records are retrieved in the query results.

API Usage¶

See Token Management API for more information on how to create and use the access token.

Time Series of Charger¶

Prepare Request Body¶

To prepare a request body, perform the following steps.

1. Set charger ID to the request path parameter chargerId. See Time Series API Reference.

Example Request¶

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export CHARGER_ID = <YOUR_CHARGER_ID>
export MEASURAND = <YOUR_MEASURAND>
export PHASE = <YOUR_PHASE>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/timeSeries/chargers/$CHARGER_ID?measurand=$MEASURAND&phase=$PHASE' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body¶

Successful response returns 200 HTTP status code with response body as TimeSeriesDataList schema. For more information, see Time Series API Reference.

Example Response¶

{
  "items": [
    {
      "timeStamp": "2022-08-18T05:23:04.334Z",
      "value": "true"
    }
  ]
}

Measurand and Phase Mapping for Charger¶

Time Series of Connector¶

Prepare Request Body¶

To prepare a request body, perform the following steps.

1. Set charger ID to the request path parameter chargerId.
2. Set connector ID to the request path parameter connectorId. See Time Series API Reference.

Example Request¶

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export CHARGER_ID = <YOUR_CHARGER_ID>
export CONNECTOR_ID = <YOUR_CONNECTOR_ID>
export MEASURAND = <YOUR_MEASURAND>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/timeSeries/chargers/$CHARGER_ID/connectors/$CONNECTOR_ID?measurand=$MEASURAND' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body¶

Successful response returns 200 HTTP status code with response body as TimeSeriesDataList schema. For more information, see Time Series API Reference.

Example Response¶

{
  "items": [
    {
      "timeStamp": "2022-08-18T05:23:04.334Z",
      "value": "true"
    }
  ]
}

Measurand and Phase Mapping for Connector¶