GET Series Continuation

Description

Introduction

When analysts make corrections or merge data, Series IDs can change. When this happens, the original Series ID becomes inactive and a new Series ID is generated. If you continue querying the API with a deprecated Series ID, no data will be returned.

The Series Continuation API allows you to verify whether a Series ID is still active and retrieve its current replacement if it has been deprecated. By providing a company identifier and Series ID, you can ensure your queries always use the most current data.

This ensures you always have access to the most up-to-date data in your applications.

Definitions

SPLIT (1 → n)

A single series is split into two or more new series. This typically happens when an analyst identifies that a previously grouped series actually represents multiple distinct entities.

Example:
[23] → [24, 25]
Series 23 is split into Series 24 and Series 25.

MERGE (n → 1)

Two or more series are merged into a single new series. This is usually due to a realization that multiple series actually represent the same underlying entity or dataset.

Example:
[23, 24] → [26]
Series 23 and Series 24 are merged to form Series 26.

COMPOSITE (n → n)

One or more fundamentals from one series are moved to another, or fundamentals from multiple series are interchanged or combined to form a new set of series. This transformation may result in partial or full redistribution of data across series.

Example:
[23, 24] → [25, 26]
Data from Series 23 and 24 is redistributed and combined to create Series 25 and 26.


Request Format

GET https://app.daloopa.com/api/v2/series-continuation

Query Parameters

ItemData TypeRequiredDescription
company_idinteger❌No*ID of the company
series_idinteger❌No*ID of the series
created_atdatetime (ISO 8601)❌NoThe timestamp when the deprecation event occurred, in ISO 8601 format (e.g., "2022-11-07T08:55:28.410005Z").
  • Either company_id or series_id must be provided.

Example Request

curl --request GET \
  --url 'https://ap.daloopa.com/api/v2/series-continuation?company_id=2' \
  --header 'Authorization: Basic APIKEY'

Response

Status : 200

Output: JSON

Response Schema

The API returns an array of objects, where each object represents a series deprecation event. Below is the schema for each field in the response:

Top-Level Object

FieldTypeDescription
old_seriesArrayAn array of objects representing the deprecated series that have been replaced.
new_seriesArrayAn array of objects representing the new series that replace the deprecated ones.
typeString (Deprecation Types)The type of deprecation event. Possible values include "COMPOSITE", "SPLIT" and "MERGE"
created_atString (ISO 8601 datetime)The timestamp when the deprecation event occurred, in ISO 8601 format (e.g., "2022-11-07T08:55:28.410005Z").

Series Object (used in both old_series and new_series)

FieldTypeDescription
idIntegerThe unique identifier for the series.
full_series_nameStringThe complete name of the series, including all classification hierarchies.
created_atString (ISO 8601 datetime)The timestamp when the series was created, in ISO 8601 format.##

Deprecation Types

Type ValueDescriptionSummary
SPLITIndicates that one series (1) was split into multiple (n) new series.SPLIT (1 → n): A single series is split into two or more new series. This typically happens when an analyst identifies that a previously grouped series actually represents multiple distinct entities
MERGEIndicates that multiple series (n) were merged into a single (1) new series.MERGE (n → 1): Two or more series are merged into a single new series. This is usually due to a realization that multiple series actually represent the same underlying entity or dataset
COMPOSITEIndicates that data from multiple series (n) was redistributed across multiple (n) new series.COMPOSITE (n → n): One or more fundamentals from one series are moved to another, or fundamentals from multiple series are interchanged or combined to form a new set of series. This transformation may result in partial or full redistribution of data across series