Data Dictionary

Post Report API Schema

Available Fields

Identifiers

Field Name	Type	Description	Availability
`creativex_post_id`	Integer	A unique identifier assigned to a specific post within the CreativeX platform.	All posts
`creativex_asset_id`	Integer	A unique identifier assigned to a specific creative asset.	All posts

Status & Metadata

Field Name	Type	Description	Availability
`status`	String	The creative asset's status in the CreativeX platform, either 'Pre-Flight' or 'In-Flight'.	All posts
`name`	String	The original filename of the creative asset.	Pre-flight only
`email`	String	The email address associated with the user who submitted the creative.	Pre-flight only
`brand`	String	The brand name that the creative asset is associated with.	All posts
`market`	String	The specific geographic region or country the creative is intended for or running in.	All posts
`channel`	String	The media platform where the ad is being displayed (e.g., DV360, Facebook, Instagram).	All posts
`company`	String	The parent company or organization associated with the brand.	All posts
`asset_type`	String	The format of the creative, either 'video' or 'image'.	All posts
`content_type`	String	The classification of the creative content, either 'brand' or 'creator'.	All posts
`ad_format`	String	The specific format of the ad placement.	Posts from channels that support ad formats
`branded`	Boolean	Indicates if content is brand consistent based on brand cue analysis	All posts (requires brand consistency access)

Spend Metrics

Field Name	Type	Description	Default Value	Availability
`total_spend`	Decimal	The total amount of money spent on this specific creative or post.	0	In-flight only
`currency`	String	The currency in which the spend is reported.	null	In-flight only (returns "USD" only when spend data exists)

Post & URL Information

Field Name	Type	Description	Availability
`date_captured`	Date	The date on which the creative and its data were first recorded by the system.	All posts
`creative_link`	String (URL)	A direct URL to view or download the creative asset file.	All posts
`post_link`	String (URL)	A URL to view the live ad or post on its respective platform.	In-flight only
`ad_id`	String	A unique identifier assigned by the advertising platform (e.g., Facebook Ad ID).	In-flight only
`ad_name`	String	Name of the ad on the platform	In-flight only

Publisher Information

Field Name	Type	Description	Availability
`publisher`	String	The specific website or app where the ad is displayed.	Posts from channels that support publishers

Ad Details

Field Name	Type	Description	Availability
`cta_type`	String	The text or button that encourages users to take a specific action.	In-flight only

Creative Format

Field Name	Type	Description	Availability
`aspect_ratio`	String	The aspect ratio of the creative asset in pixels.	All posts
`dimensions`	String	The dimensions of the creative asset in pixels.	All posts (when dimensions available)
`width`	Integer	The width of the creative asset in pixels.	All posts
`height`	Integer	The height of the creative asset in pixels.	All posts
`video_length`	Decimal	The total duration of the video asset, typically in seconds.	Video assets only

Platform Details

Field Name	Type	Description	Availability
`ad_account_name`	String	The name of the advertising account from which the ad was run.	In-flight only
`ad_account_id`	String	The unique identifier for the advertising account.	In-flight only
`campaign_name`	String	The name of the advertising campaign the creative belongs to.	In-flight only
`campaign_id`	String	The unique identifier for the advertising campaign.	In-flight only
`campaign_objective`	String	The primary goal of the campaign.	In-flight only

Platform Metrics

Field Name	Type	Description	Availability
`impressions`	Integer	The total number of times an ad has been displayed on a screen.	In-flight only
`reach`	Integer	The number of unique people who saw your ads at least once.	In-flight only
`clicks`	Integer	The total number of clicks on your ad.	In-flight only
`engagements`	Integer	The total number of interactions with your ad (e.g., likes, comments, shares, clicks).	In-flight only
`conversions`	Decimal	The number of times a user completes a desired action (e.g., purchase, sign-up).	In-flight only
`all_conversions`	Decimal	A comprehensive count of all conversion actions being tracked.	In-flight only
`purchase_count`	Integer	The total number of purchases made as a result of the ad.	In-flight only
`estimated_ad_recallers`	Integer	The estimated number of people who will remember seeing your ad if asked within two days.	In-flight only

Calculated Metrics

Field Name	Type	Description	Formula	Availability
`cpm`	Decimal	The average cost for 1,000 impressions.	(spend / impressions) × 1000	In-flight only
`cpc`	Decimal	The average amount you pay for a single click. Calculated as (TotalSpend÷Clicks).	spend / clicks	In-flight only
`ctr`	Decimal	The percentage of impressions that resulted in a click. Calculated as (Clicks÷Impressions)×100.	clicks / impressions	In-flight only
`engagement_rate`	Decimal	The percentage of people who saw an ad and engaged with it. Calculated as (Engagements÷Reach).	engagements / reach	In-flight only
`purchase_rate`	Decimal	The percentage of users who made a purchase after interacting with the ad.	purchase_count / impressions	In-flight only
`estimated_ad_recall_rate`	Decimal	The percentage of people who are likely to remember your ad. (EstimatedAdRecallers÷Reach).	estimated_ad_recallers / reach	In-flight only
`cost_per_estimated_ad_recaller`	Decimal	The average cost for each person who is estimated to recall your ad.	spend / estimated_ad_recallers	In-flight only
`roas`	Decimal	Return on Ad Spend	Platform-provided metric	In-flight only
`new_to_brand_roas`	Decimal	ROAS calculated specifically from purchases made by new customers.	Platform-provided metric	In-flight only
`new_to_brand_purchase_rate`	Decimal	The purchase rate specifically for new customers.	Platform-provided metric	In-flight only
`dpvr`	Decimal	The percentage of users who clicked an ad and then viewed a product detail page.	Platform-provided metric	In-flight only

Important Note on Rate Metrics: Rate metrics (CTR, engagement_rate, purchase_rate, etc.) are returned as decimals, not percentages. To display as percentages, multiply by 100 (e.g., 0.005 → 0.5%).

Video Metrics

Field Name	Type	Description	Availability
`unique_video_3_sec_views`	Integer	The number of unique users who played your video for at least 3 seconds.	In-flight video posts only
`video_3_sec_views`	Integer	The number of times your video was played for at least 3 seconds.	In-flight video posts only
`video_15_sec_views`	Integer	The number of times your video was played for at least 15 seconds (or to completion if shorter).	In-flight video posts only
`video_30_sec_views`	Integer	The number of times your video was played for at least 30 seconds (or to completion if shorter).	In-flight video posts only
`video_25_views`	Integer	The number of times your video was played to 25% of its length.	In-flight video posts only
`video_50_views`	Integer	The number of times your video was played to 50% of its length.	In-flight video posts only
`video_75_views`	Integer	The number of times your video was played to 75% of its length.	In-flight video posts only
`video_100_views`	Integer	The number of times your video was played to completion.	In-flight video posts only
`video_avg_time_watched`	Decimal	The average duration people spent watching your video.	In-flight video posts only

Important Note on Video Completion Metrics: Video completion metrics (video_25_views through video_100_views) represent the number of times the video was played to each completion threshold, not percentages.

Regulatory Data

Field Name	Type	Description	Default Value	Availability
`compliant`	Boolean	Overall compliance status - true if all regulations are met	false	All posts (requires regulatory access)
`regulations`	Array of Objects	Detailed regulation results for each configured regulation	null (or [] if data exists)	All posts (requires regulatory access)

Regulations Object Schema:

{
  "regulation_id": "string (UUID)",
  "regulation_name": "string",
  "value": 1
}

Each regulation object includes:

regulation_id: UUID of the regulation (stored as a string)
regulation_name: Display name of the regulation
value: Result value (1 for pass, 0 for fail)

Quality Scores

Field Name	Type	Description	Availability
`scores`	Object	The scores you are tracking through the CreativeX platform.	All posts (requires quality access)

Scores Object Schema:
Dynamic fields based on company's configured scores. Example:

{
  "creative_quality": 85.5,
  "creative_quality_tier": "Excellent",
  "brand_consistency": 92.0,
  "brand_consistency_tier": "Outstanding"
}

The scores are calculated from guideline data and ranked according to company-configured tier thresholds.

Guidelines

Field Name	Type	Description	Availability
`guidelines`	Array of Objects	Creative guidelines you are tracking through the CreativeX platform, e.g. Brand Early	All posts (requires quality access)

Guidelines Object Schema:

{
  "guideline_id": "string (UUID)",
  "guideline_name": "string",
  "value": "integer (0 or 1)"
}

Each guideline object includes:

guideline_id: UUID of the guideline (stored as a string)
guideline_name: Display name of the guideline (e.g., "Logo Visible", "Brand Colors Present", "Faces Present")
value: Result value (integer: 0 or 1)

Third-Party Data

Field Name	Type	Description	Availability
`datalink_partner_data`	Object	An example of an integrated third-party score that predicts a creative's in-market performance.	Posts with completed scoring requests

Third-Party Data Object Schema:

{
  "partner-name": {
    "scores": {
      "score_identifier": "value"
    },
    "supplementary_data": {},
    "metrics": {}
  }
}

The structure varies based on configured third-party integrations. Each partner's data includes:

scores: Partner-provided scores (e.g., attention_score, brand_lift)
supplementary_data: Additional contextual information (e.g., survey_sample_size)
metrics: Partner-specific metrics (e.g., aided_awareness, purchase_intent)

Complete Example Response

Post Report Response (In-Flight Video Post):

{
  "creativex_post_id": 123456,
  "creativex_asset_id": 789012,
  "status": "In-Flight",
  "brand": "Acme Corp",
  "market": "United States",
  "channel": "Facebook",
  "company": "Acme Partners",
  "asset_type": "video",
  "content_type": "brand",
  "ad_format": "Feed Video",
  "branded": true,
  "total_spend": 12500.50,
  "currency": "USD",
  "date_captured": "2023-06-15",
  "creative_link": "https://example.com/assets/789012",
  "post_link": "https://example.com/ads/library/?id=987654321",
  "ad_id": "987654321",
  "ad_name": "Summer Campaign - Video Ad 1",
  "publisher": "Facebook News Feed",
  "cta_type": "SHOP_NOW",
  "aspect_ratio": "16:9",
  "dimensions": "1920 x 1080",
  "width": 1920,
  "height": 1080,
  "video_length": 30.5,
  "ad_account_name": "Acme Corp - Main Account",
  "ad_account_id": "act_123456789",
  "campaign_name": "Summer 2023 Campaign",
  "campaign_id": "camp_987654321",
  "campaign_objective": "CONVERSIONS",
  "impressions": 1250000,
  "reach": 850000,
  "clicks": 6250,
  "engagements": 31250,
  "conversions": 187.5,
  "all_conversions": 215.3,
  "purchase_count": 125,
  "estimated_ad_recallers": 150000,
  "cpm": 10.0,
  "cpc": 2.0,
  "ctr": 0.005,
  "engagement_rate": 0.025,
  "purchase_rate": 0.0001,
  "estimated_ad_recall_rate": 0.176,
  "cost_per_estimated_ad_recaller": 0.083,
  "roas": 3.5,
  "new_to_brand_roas": 4.2,
  "new_to_brand_purchase_rate": 0.00008,
  "dpvr": 0.15,
  "unique_video_3_sec_views": 900000,
  "video_3_sec_views": 1000000,
  "video_15_sec_views": 500000,
  "video_30_sec_views": 250000,
  "video_25_views": 60,
  "video_50_views": 40,
  "video_75_views": 26,
  "video_100_views": 15,
  "video_avg_time_watched": 18.7,
  "compliant": false,
  "regulations": [
    {
      "regulation_id": "550e8400-e29b-41d4-a716-446655440100",
      "regulation_name": "FDA Compliance",
      "value": 0
    },
    {
      "regulation_id": "550e8400-e29b-41d4-a716-446655440101",
      "regulation_name": "Age Restriction",
      "value": 1
    }
  ],
  "scores": {
    "creative_quality": 85.5,
    "creative_quality_tier": "Excellent",
    "brand_consistency": 92.0,
    "brand_consistency_tier": "Outstanding",
    "effectiveness_score": 78.3,
    "effectiveness_score_tier": "Good"
  },
  "guidelines": [
    {
      "guideline_id": "550e8400-e29b-41d4-a716-446655440500",
      "guideline_name": "Logo Visible",
      "value": 1
    },
    {
      "guideline_id": "550e8400-e29b-41d4-a716-446655440501",
      "guideline_name": "Brand Colors Present",
      "value": 0
    },
    {
      "guideline_id": "550e8400-e29b-41d4-a716-446655440502",
      "guideline_name": "Faces Present",
      "value": 1
    }
  ],
  "datalink_partner_data": {
    "nielsen": {
      "scores": {
        "attention_score": 95.2,
        "brand_lift": 12.5
      },
      "supplementary_data": {
        "survey_sample_size": 1500
      },
      "metrics": {
        "aided_awareness": 68.4,
        "purchase_intent": 23.7
      }
    }
  }
}

Post Report Response (Pre-Flight Image Post):

{
  "creativex_post_id": 234567,
  "creativex_asset_id": 890123,
  "status": "Pre-Flight",
  "name": "summer_promo_image_v2.jpg",
  "email": "[email protected]",
  "brand": "Acme Corp",
  "market": "United Kingdom",
  "channel": "Instagram",
  "company": "Acme Partners",
  "asset_type": "image",
  "content_type": "creator",
  "ad_format": "Story",
  "branded": false,
  "date_captured": "2023-06-20",
  "creative_link": "https://example.com/assets/890123",
  "aspect_ratio": "9:16",
  "dimensions": "1080 x 1920",
  "width": 1080,
  "height": 1920,
  "compliant": true,
  "regulations": [],
  "scores": {
    "creative_quality": 72.0,
    "creative_quality_tier": "Good",
    "brand_consistency": 45.5,
    "brand_consistency_tier": "Needs Improvement"
  },
  "guidelines": [
    {
      "guideline_id": "550e8400-e29b-41d4-a716-446655440500",
      "guideline_name": "Logo Visible",
      "value": 0
    },
    {
      "guideline_id": "550e8400-e29b-41d4-a716-446655440501",
      "guideline_name": "Brand Colors Present",
      "value": 1
    }
  ]
}

Core Asset Report API Schema

Available Fields

Core Asset Identifiers

Field Name	Type	Description
`core_asset_id`	String (UUID)	Unique identifier for the core asset
`core_asset_production_partner`	String	Name of the production partner organization
`core_asset_measurement_partner`	String	Name of the measurement partner organization
`core_asset_campaign_names`	Array of Strings	Names of all campaigns using this core asset
`core_asset_brands`	Array of Strings	Brand names associated with campaigns using this asset
`core_asset_filename`	String	Filename of the core asset
`core_asset_link`	String (URL)	URL to view the core asset in CreativeX

Matched Posts Summary

Field Name	Type	Description
`brands`	Array of Strings	Unique list of brands from matched in-flight posts (distinct from core_asset_brands)
`markets`	Array of Strings	Unique list of markets where the core asset has been activated
`channels`	Array of Strings	Unique list of channels where the core asset has been activated
`creativex_asset_post_ids`	Array of Integers	List of CreativeX post IDs that are variations/adaptations of this core asset
`total_posts`	Integer	Total number of matched posts derived from this core asset
`total_assets`	Integer	Total number of unique assets (variations) derived from this core asset

Aggregated In-Flight Metrics

Field Name	Type	Description
`activated_spend`	Decimal	Total USD spend across all matched in-flight posts within the date range
`activated_impressions`	Integer	Total impressions across all matched in-flight posts within the date range

Complete Example Response

Core Asset Report Response:

{
  "core_asset_id": "750e8400-e29b-41d4-a716-446655440010",
  "core_asset_production_partner": "Creative Production Partners LLC",
  "core_asset_measurement_partner": "Analytics Measurement Co",
  "core_asset_campaign_names": [
    "Summer 2023 Campaign",
    "Back to School 2023",
    "Holiday Season 2023"
  ],
  "core_asset_brands": [
    "Acme Corp",
    "Acme Electronics"
  ],
  "core_asset_filename": "master_video_30sec_16x9_v3.mp4",
  "core_asset_link": "https://example.com/core-assets/750e8400-e29b-41d4-a716-446655440010",
  "brands": [
    "Acme Corp",
    "Acme Electronics"
  ],
  "markets": [
    "United States",
    "United Kingdom",
    "Canada",
    "Australia"
  ],
  "channels": [
    "Facebook",
    "Instagram",
    "YouTube",
    "TikTok"
  ],
  "creativex_asset_post_ids": [
    123456,
    123457,
    123458,
    234567,
    234568,
    345678,
    345679,
    456789
  ],
  "total_posts": 8,
  "total_assets": 6,
  "activated_spend": 487250.75,
  "activated_impressions": 52840000
}

Report Parameters

Post Report Filters

Parameter	Type	Description
`start_date`	String (YYYY-MM-DD)	Start date for the report period. Must align with calendar boundaries (month, quarter, half-year, or year start).
`end_date`	String (YYYY-MM-DD)	End date for the report period. Must align with calendar boundaries (month, quarter, half-year, or year end).
`brands`	Array of Strings	Filter by brand names. Only posts associated with specified brands will be included.
`markets`	Array of Strings	Filter by market names. Only posts associated with specified markets will be included.
`channels`	Array of Strings	Filter by channel labels. Only posts from specified channels will be included.
`content_types`	Array of Strings	Filter by content types (e.g., brand, creator, ugc). Only posts of specified types will be included.
`ad_formats`	Array of Strings	Filter by ad format labels. Only posts with specified ad formats will be included.
`fields`	Array of Strings	Specify which fields to include in the response. If omitted, all available fields (based on access permissions) will be returned.

Core Asset Report Filters

Parameter	Type	Description
`start_date`	String (YYYY-MM-DD)	Start date for in-flight data aggregation. Only in-flight posts within this date range contribute to aggregated metrics.
`end_date`	String (YYYY-MM-DD)	End date for in-flight data aggregation. Only in-flight posts within this date range contribute to aggregated metrics.
`core_asset_brands`	Array of Strings	Filter by brands associated with core asset campaigns. Only core assets from campaigns with specified brands will be included.
`inflight_markets`	Array of Strings	Filter matched in-flight posts by market. Only aggregates data from posts activated in specified markets.
`inflight_channels`	Array of Strings	Filter matched in-flight posts by channel. Only aggregates data from posts activated on specified channels.
`fields`	Array of Strings	Specify which fields to include in the response. If omitted, all available fields will be returned.