Custom Report

The Custom Report pipeline can be used to request and retrieve data based on a wide variety of dimensions and metrics as per user requirement. User may also choose to include Custom Dimensions, Cohort Metrics and Conversion Metrics.

Configuring the Credentials

Select the account credentials which has access to relevant Singular data from the dropdown menu & Click Next

Credentials not listed in dropdown ?

Click on + Add New for adding new credentials

Data Pipelines Details

Data Pipeline

Select Custom Report from the dropdown

Setting Parameters

Parameter Description Values

Dimensions & Metrics

Required

Select the dimensions and metrics you would like to fetch from the Singular API. Results are grouped in the order that you supply these dimensions and the grouping dimension values are combined to create a unique key for each result row.

For more details about dimensions and metrics go here

Include Custom Dimension

Select Yes, if you want to retrieve the IDs of any custom dimensions configured for your account, else select No.

{Yes, No}

Default Value: No

Include Cohort Metrics

Select Yes, if you want to retrieve all the cohort metrics and cohort periods available for your account. This includes any in-app events you configured Singular to track, else select No.

{Yes, No}

Default Value: No

Include Conversion Metrics

Select Yes, if you want to retrieve all the conversion events available for your account, else select No.

{Yes, No}

Default Value: No

Insert Mode

Required

This refers to the manner in which data will get updated in the data warehouse, with 'Delete' selected, the data will be upserted (only new records or records with changes) and with 'Append' selected, all data fetched will be inserted. Selecting 'Replace' will ensure the table is dropped and recreated with fresh data on each run. Recommended to use "Upsert" option unless there is a specific requirement.

Upsert, Append, Replace

Default Value: Upsert

Number of Days

Required

Number of days for which you wish to get the data in each run.

Integer value (Recommended value 2)

Datapipeline Scheduling

Scheduling specifies the frequency with which data will get updated in the data warehouse. You can choose between Manual Run, Normal Scheduling or Advance Scheduling.

Manual Run

If scheduling is not required, you can use the toggle to run the pipeline manually.

Normal Scheduling

Use the dropdown to select an interval-based hourly, monthly, weekly, or daily frequency.

Advance Scheduling

Set schedules fine-grained at the level of Months, Days, Hours, and Minutes.

Detailed explanation on scheduling of pipelines can be found here

Dataset & Name

Dataset Name

Key in the Dataset Name(also serves as the table name in your data warehouse).Keep in mind, that the name should be unique across the account and the data source. Special characters (except underscore _) and blank spaces are not allowed. It is best to follow a consistent naming scheme for future search to locate the tables.

Dataset Description

Enter a short description (optional) describing the dataset being fetched by this particular pipeline.

Notifications

Choose the events for which you’d like to be notified: whether "ERROR ONLY" or "ERROR AND SUCCESS".

Once you have finished click on Finish to save it. Read more about naming and saving your pipelines including the option to save them as templates here

Still have Questions?

We’ll be happy to help you with any questions you might have! Send us an email at info@datachannel.co.

Subscribe to our Newsletter for latest updates at DataChannel.