Skip to main content

adsLibraryPreviewPerformance

Same result, arguments, and access as adPerformance: spend, tracked visits, attributed conversions, rankings, daily charts, and recommendations for a site's ads. Requires Ad Performance view access.

adsLibraryPreviewPerformance(
  siteId: Int!
  startAt: Int
  endAt: Int
  presetDate: String
  platforms: [AdPlatformSource!]
  campaignIds: [Int!]
  adGroupIds: [Int!]
  adIds: [Int!]
  goalId: Int
  dataMode: AdPerformanceDataMode
  attributionModel: AdPerformanceAttributionModel
  conversionWindowDays: Int
): AdPerformance

Arguments​

adsLibraryPreviewPerformance.siteId ● Int! non-null scalar​

Accessible site id from sites.

adsLibraryPreviewPerformance.startAt ● Int scalar​

Unix seconds; uses the UTC date as an inclusive start. Omit for no lower bound; presetDate takes precedence.

adsLibraryPreviewPerformance.endAt ● Int scalar​

Unix seconds; uses the UTC date as an inclusive end. Omit for no upper bound; presetDate takes precedence.

adsLibraryPreviewPerformance.presetDate ● String scalar​

Case-insensitive UTC preset that overrides startAt/endAt: today, yesterday, recent, last 7 days, last 30 days, this month, last month. recent includes today; last 7/30 days exclude it. Other values return an error.

adsLibraryPreviewPerformance.platforms ● [AdPlatformSource!] list enum​

Providers to include in PLATFORM mode; omitted or [] selects all enabled connections. Ignored in UTM mode.

adsLibraryPreviewPerformance.campaignIds ● [Int!] list scalar​

Crazy Egg campaign ids from adPerformanceAdTree; unioned with ad-group/ad filters. First 500 unique ids used; ignored in UTM mode.

adsLibraryPreviewPerformance.adGroupIds ● [Int!] list scalar​

Crazy Egg ad-group ids from adPerformanceAdTree; unioned with campaign/ad filters. First 500 unique ids used; ignored in UTM mode.

adsLibraryPreviewPerformance.adIds ● [Int!] list scalar​

Crazy Egg ad ids from adPerformanceAdTree; unioned with campaign/ad-group filters. First 500 unique ids used; ignored in UTM mode.

adsLibraryPreviewPerformance.goalId ● Int scalar​

Goal id from goalCardList or controls.availableGoals; 0 counts all goals. When omitted, a goal with conversions in the range is chosen and reported in controls.selectedGoalId, or all goals when none has any.

adsLibraryPreviewPerformance.dataMode ● AdPerformanceDataMode enum​

PLATFORM matches imported ads and includes spend; UTM groups tracking parameters without spend. Defaults to PLATFORM.

adsLibraryPreviewPerformance.attributionModel ● AdPerformanceAttributionModel enum​

Earliest or latest eligible ad visit before conversion; defaults to LAST_TOUCH.

adsLibraryPreviewPerformance.conversionWindowDays ● Int scalar​

Lookback from conversion to eligible ad visit, in days: 1, 7, 30, or 90. Defaults to 1; other values fall back to 1.

Type​

AdPerformance object​

Performance response combining effective filters, aggregate metrics, rankings, charts, recommendations, and load statuses. Returned by adPerformance and adsLibraryPreviewPerformance.