Preview API: Removal of property from 'dataIngestionRules'

Description

We are removing the property dataIngestionRules and instead will provide metadata information of the data ingestion rules in the new property dataIngestionRulesMetaData which includes counts associated with platform in a topic. To enable you to fetch the data ingestion rules of a given topic, we are providing support with new API, api/v2/socialmedia/topics/{topicId}/dataingestionrules , that supports pagination.

Change Category

API

Change Context

We will remove the property from the contract and include a new property of dataIngestionRulesMetaData where we provide the metadata information like counts of rules with platform and platforms associated in the topic. Additionallly, we will providing a new API for GET of dataIngestionRules of Topic with paginationSupport.

Change Impact

With the above implementation we will no longer return dataIngestionRules in the below APIs:

  • GET api/v2/socialmedia/topics
  • GET api/v2/socialmedia/topics/{topicId}

Instead, we will add a new property, dataIngestionRulesMetadata, that returns the rules count by platforms and the platforms in the topic.

So to fetch the dataIngestionRules we are providing support with new API: api/v2/socialmedia/topics/]{topicId}/dataingestionrules that supports pagination.

Customers should use this API instead of relying on the data of dataIngestionRules API

Date of Change

Immediate

Impacted APIs

api/v2/socialmedia/topics
api/v2/socialmedia/topics/{topicId}

References

[LISTEN-865]
[LISTEN-863]