Stats Performance

Stats Performance pipeline can be used to fetch details about the analytics metrics that help partners and advertisers understand the performance of the content they promote on Twitter.

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

Configuring the Credentials

Select the account credentials which has access to relevant Twitter Ads 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 StatsPerformance 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

Setting Parameters

Parameter	Description	Values
Entity	*Required* Select accordingly to fetch objects you want to retrieve the performance stats of.	{Campaign,Funding_Instrument,Line_Item,Organic_Tweet,Promoted_Account,Promoted_Tweet,Media_Creative,Account}
Granularity	*Required* Select accordingly to a specific granular level for the retrieved data.	{Hour,Day,Total}
Metric Groups	*Required* Select accordingly to display specific metrics. Refer to complete list of Metrics and Segmentation	{Billing,Engagement,Life_Time_Value_Mobile_Conversion,Media,Mobile_Conversion,Video,Web_Conversion}
Placement	*Required* Select accordingly to set the scope of the retrieved data to a particular placement. Select Both to include all.	{Publisher_Network,All_On_Twitter,Both}
Segmentation Type	*Required, Only a single value accepted per request.* Specify how the retrieved data should be segmented.	{Age,App_Store_Category,Audiences,Metros,Conversations,Conversion_Tags,Devices,Events,Gender,Interests,Keywords,Languages,Locations,Platforms,Platform_Versions,Postal_Codes,Regions,Similar_To_Followers_Of_Users,TV_Shows}
No of Days	*Required* Select accordingly to specify the number of days for which you wish to get the data in each run.	Integer value (Recommended value 7)
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

Parameter

Description

Values

Entity

Required

Select accordingly to fetch objects you want to retrieve the performance stats of.

{Campaign,Funding_Instrument,Line_Item,Organic_Tweet,Promoted_Account,Promoted_Tweet,Media_Creative,Account}

Granularity

Required

Select accordingly to a specific granular level for the retrieved data.

{Hour,Day,Total}

Metric Groups

Required

Select accordingly to display specific metrics. Refer to complete list of Metrics and Segmentation

{Billing,Engagement,Life_Time_Value_Mobile_Conversion,Media,Mobile_Conversion,Video,Web_Conversion}

Placement

Required

Select accordingly to set the scope of the retrieved data to a particular placement. Select Both to include all.

{Publisher_Network,All_On_Twitter,Both}

Segmentation Type

Required, Only a single value accepted per request.

Specify how the retrieved data should be segmented.

{Age,App_Store_Category,Audiences,Metros,Conversations,Conversion_Tags,Devices,Events,Gender,Interests,Keywords,Languages,Locations,Platforms,Platform_Versions,Postal_Codes,Regions,Similar_To_Followers_Of_Users,TV_Shows}

No of Days

Required

Select accordingly to specify the number of days for which you wish to get the data in each run.

Integer value (Recommended value 7)

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

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.