.do
ApiMarketing

AdReport

A detailed performance report for an individual advertisement including delivery metrics, engagement data, conversion tracking, and optimization insights.

AdReport

A detailed performance report for an individual advertisement including delivery metrics, engagement data, conversion tracking, and optimization insights.

Properties

  • id (string): Unique identifier for the ad report
  • ad ([[Ad]]): The advertisement this report covers
  • campaign ([[Campaign]]): The campaign the ad belongs to
  • timeRange (object): Time period covered by the report
  • impressions (number): Total impressions delivered
  • clicks (number): Total clicks received
  • conversions (number): Total conversions tracked
  • spentCents (number): Total amount spent in cents
  • revenueCents (number): Total revenue generated in cents
  • ctr (number): Click-through rate (clicks / impressions)
  • cpcCents (number): Cost per click in cents
  • cpaCents (number): Cost per acquisition in cents
  • cpmCents (number): Cost per thousand impressions in cents
  • roas (number): Return on ad spend (revenue / spend)
  • frequency (number): Average times ad shown per user
  • reach (number): Unique users who saw the ad
  • engagement (object): Engagement metrics (likes, shares, comments)
  • deviceBreakdown (object): Performance by device type
  • locationBreakdown (object): Performance by location
  • insights (object[]): Performance insights
  • recommendations (object[]): Optimization recommendations
  • format (string): Report format (json, pdf, excel)
  • generatedAt (string): ISO 8601 timestamp of generation
  • metadata (object): Additional report data

Actions

create

Generate a new ad report

Input: [[AdReport]]
Output: [[AdReport]]

read

Retrieve report by ID

Input: string
Output: [[AdReport]]

compare

Compare with other ads

Input: [[ComparisonRequest]]
Output: [[AdReport]]

export

Export report to file

Input: [[AdReport]]
Output: [[File]]

list

List all ad reports

Input: -
Output: [[AdReport]][]

Events

  • created: Fired when report is generated
  • exported: Fired when report is exported