Skip to main content

Extra Costs (automated) Requirements

Technical specification for clients exporting extra cost data to Kickbite via cloud storage — destination, update frequency, format, file naming, and required fields.

Written by Juan Garzon

Overview

This article describes the technical requirements for exporting extra cost data (e.g. Criteo, Awin, influencer, affiliate, partner-network spend) from your systems into Kickbite via a cloud storage bucket.

Use this spec when you want Kickbite to automatically ingest extra cost data on a recurring schedule, rather than entering costs manually in Settings → Extra Costs.

Destination

Deliver files to either:

  • Google Cloud Storage

  • GDrive

  • Bigquery

  • AWS S3 bucket

Other destinations can be discussed with the Kickbite team on request.

Frequency of updates

The last 2 months of data, including yesterday, must be updated in the bucket before 2:00 AM (website timezone) every day.

Example: For the Germany website on 18.06.2024, the file containing that day's data (plus the previous month, May) should be available in the bucket on 19.06.2024 before 2:00 AM CET.

File format

One file per month, in either CSV or JSON format.

File naming convention

Use the following pattern:

cost_YYYY_MM

Where YYYY is the four-digit year and MM is the two-digit month (e.g. cost_2024_06).

Required fields

Each row represents a single ad activity for a given day. Fields marked with an asterisk (*) are mandatory.

Field

Example

Description

date *

2022-01-10T12:39:51Z

Date of promotional activity (UTC timestamp).

platform

Criteo, Awin, partner network, etc.

Name of the platform or partner source.

market *

DE

Ad country identifier — country abbreviation or country name.

sale_channel

webstore1

Webstore identifier, used when multiple webstores are connected.

channel *

Influencers, Affiliate, Partnerships, etc.

Marketing channel name. Must match your channel definition rules exactly.

campaign_name

Campaign 1

Name of the campaign, if it's available as a separate entity.

utm_source

utm tag

UTM source tag, if available as a separate entity.

utm_campaign

utm tag

UTM campaign tag, if available as a separate entity.

utm_medium

utm tag

UTM medium tag, if available as a separate entity.

utm_content

utm tag

UTM content tag, if available as a separate entity.

impressions

100

Sum of impressions for the specific ad activity in the period.

clicks

100

Sum of clicks for the specific ad activity in the period.

currency *

EUR

Currency of the cost values.

cost *

100.00

Spend amount for the specific ad activity in the period.

* — Mandatory columns

Quick checklist

  • Bucket (GCS or S3) configured and shared with Kickbite

  • One file per month: cost_YYYY_MM.csv or cost_YYYY_MM.json

  • Last 2 months updated daily before 2:00 AM (website timezone)

  • All mandatory fields present: date, market, channel, currency, cost

  • channel values match your Kickbite channel definition rules exactly

Need help?

If you'd like to set up an extra costs export or discuss a non-standard destination, reach out to your Kickbite contact or message us in the chat.

Did this answer your question?