Campaign Stats

This pipeline provides campaign stats data that is updated approximately every 15 minutes. All stats requests can be made with TOTAL, DAY, or HOUR granularity.

You can read more about this on the Snapchat marketing API documentation page here

Configuring the Credentials

Select the account credentials which has access to relevant Snapchat 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 CampaignStats from the dropdown
Account: Select one or more accounts from the drop-down

All accounts which your credentials have access to should be available here. If they are not, please check the credentials selected / configured by you. While you can add multiple accounts, the table size may become too large and so it is advisable to add one account per pipeline and use Union queries in the data warehouse to join the data for consumption

Fields: Select the fields you would like to fetch from the Snapchat platform. You can click on View Schema anytime to see the schema of the table being created.

Each of the selected fields will create one or more columns in the database table in the destination warehouse. For a complete list of all the available fields along with their explanation refer this link.

Setting Parameters

Parameter Description Values

Parameter	Description	Values
Breakdown	*Required* Select the option according to which you want the data to be grouped. Recommended to use one breakdown per report.	{Ad,Adsquad} Object-level breakdown
Reporting Dimension	Select the dimensions you would like to fetch from the Snapchat platform. Each of the selected metrics & dimensions will create one or more columns in the database table in the destination warehouse. For a complete list of all the available metrics & dimensions along with their explanation refer this link.	`country, region, dma, gender, age, lifestyle_category, os, make`
No of Days	*Required* Number of days for which you wish to get the data in each run.	Integer value (Recommended value 30)
Delete or Append	*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. Recommended to use "Delete" option unless there is a specific requirement.	{Delete, Append} *Default Value:* Delete
Granularity	*Required* Metrics granularity	{Hour,Day,Total}
View Attribution Window	*Required* Select the desired attribution windows for the report. eg: 28d_click returns all actions that happened 28 days after someone clicked on the ad.	{1 Hour, 3 Hour, 6 Hour, 1 Day, 7 Days, 28 Days}

Breakdown

Required

Select the option according to which you want the data to be grouped. Recommended to use one breakdown per report.

{Ad,Adsquad}

Object-level breakdown

Reporting Dimension

Select the dimensions you would like to fetch from the Snapchat platform. Each of the selected metrics & dimensions will create one or more columns in the database table in the destination warehouse. For a complete list of all the available metrics & dimensions along with their explanation refer this link.

country, region, dma, gender, age, lifestyle_category, os, make

No of Days

Required

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

Integer value (Recommended value 30)

Delete or Append

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. Recommended to use "Delete" option unless there is a specific requirement.

{Delete, Append}

Default Value: Delete

Granularity

Required

Metrics granularity

{Hour,Day,Total}

View Attribution Window

Required

Select the desired attribution windows for the report. eg: 28d_click returns all actions that happened 28 days after someone clicked on the ad.

{1 Hour, 3 Hour, 6 Hour, 1 Day, 7 Days, 28 Days}

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.