Sprinklr walkthrough
Sprinklr API version 1 is currently supported.
The Sprinklr data source in Data Integration is based on Sprinklr’s reporting mechanism, which powers the widget reports in Sprinklr’s UI. Therefore, any report that works for a widget in the Sprinklr platform UI should function the same way in Data Integration.
However, the following note appears in the Sprinklr documentation:
Certain social network terms of service do not enable API transfer of data from the Sprinklr API to another data store. As such, these common metrics, or custom measures created in Sprinklr, may present different numbers than those in our Web UI when a specific channel is not returned. When querying for common metrics on the Reporting endpoint, it is recommended to query for the unique social channel metrics that comprise the common metric calculation to determine whether the data is consistent with the Web UI.
Prerequisite
Getting report data from Sprinklr data source
Sprinklr source is based on the following parameters:
Report
Reporting consists of a set of measures and dimensions that can run together. The reports available in Data Integration is generated by the Sprinklr platform reporting engine.
Dimensions
Dimensions are the group by clause of the report. Each dimension determines the granularity of the report and may affect its performance. The chosen report changes the dimensions list. Custom dimensions (based on expressions or another definition in Sprinklr) are also compatible in Data Integration.
Custom dimensions
The Post Insights report includes a field called Custom Dimensions. This enables you to gain deeper insights into social media presence, letting you create custom metrics and analyze data based on specific, user-defined parameters. With this field, you can tailor the reporting to align with specific business objectives and gain a more comprehensive understanding of the social media performance.
Measures
Measures are the metrics summarized in the report by the granularity of the dimensions. Each measurement that is selected in Data Integration using the SUM aggregation. The list of measures changes according to the chosen report. Custom measures are also compatible.
Each measurement is pulled by Data Integration with the next field pattern:
{aggregation_type}_{measure_name}
Where the aggregation type in the pattern is based on the aggregation type of the measure, for example, the measure Followers with SUM aggregation type will be pulled in Data Integration as total_followers.
Filters
Reports can be filtered by dimensions and values. The filters are combined from Dimension, Operator, and Value. The available operators are:
- >= (Greater than equals), > (Greater than)
- <= (Lower than equals), < (Lower Than)
- == (Equals), != (Not equal)
- IN (In some values)
To add a filter to the report, click Add Filter. Filters are connected with AND operators only.
Timezone
The report is based on the chosen timezone of the dates. For example, if a report is running between 1.1.25 and 2.1.25 and the timezone is set to EST, the data returned is offset to 1.1.25 in EST time. The data will be returned as UTC represented EST.
Time period
The time period can be a custom date range or a predefined time period (for example, Yesterday, last week, etc.).
Selecting Date Range
- Select the start date and end date.
- Leave the end date empty to pull data until the river runs.
- After each run of the river, the start date will be updated automatically with the end date, and the end date will be updated with the empty value. This enables the next run to pull data from the end of the previous run.
Selecting Days back
Use this input to pull data from the specified days before the given start date.
