Import Metadata

How to add general metrics data into HockeyStack (specifically helpful for paid ads reporting)

Schema:

These columns are required for this import type (column names are expected to match, for import to work properly)

Column
Required
Description

date

โœ…

The date of the campaign / ad

account_id

โœ–๏ธ

Ad account id

campaign_id

โœ–๏ธ

ID of your campaign

campaign_name

โœ…

Name of your campaign

adgroup_id

โœ–๏ธ

ID of your ad group / ad set

adgroup_name

โœ–๏ธ

Name of your ad group / ad set

ad_id

โœ–๏ธ

ID of your ad

ad_name

โœ–๏ธ

Name of your ad

utm_source

โœ–๏ธ

utm_campaign

โœ–๏ธ

Not required, but very helpful when included to be able to connect this to Page Visits tracked with website tracking

utm_term

โœ–๏ธ

utm_content

โœ–๏ธ

utm_medium

โœ–๏ธ

keyword

โœ–๏ธ

spend

โœ–๏ธ

numerical value of spend without a currency symbol, or commas

impressions

โœ–๏ธ

numerical value of impressions, without commas

clicks

โœ–๏ธ

numerical value of clicks, without commas

currency

โœ–๏ธ

Three letter currency code, defaults to 'USD' if not provided.

Refer to this guide to help determine the proper currency code if needed

The benefit of adding non-required columns:

Having these extra defined columns help better connect and enrich your data for better use within HockeyStack. Column names have to match, for import to work properly.

Caveats and Notes:

  • The metadata import follows a strict schema. Unlike actions or properties import, other columns that do not specifically match columns specified in Required or Optional schema will not be used during import.

  • UTM campaigns are very helpful for connecting this ad based data to website action based data

  • Spend, impressions, and clicks are the only metrics that can be tracked

Last updated