Summarize customer/account spend metrics

Read-only spend, impressions, clicks, conversions, revenue and derived rates from the serving warehouse. Use for questions about recent spend/performance. candidate_count=0 from candidate tools never proves metric data is absent.

post/customer-metric-summary

Request

  • Base URL: https://api.gravityads.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.gravityads.dev/customer-metric-summary
  • Auth: HTTP bearer

Request body

operator_idstring
customer_namestring
platformstring
account_idstring
start_datestring

YYYY-MM-DD

end_datestring

YYYY-MM-DD

daysinteger
source_policy'auto' | 'warehouse_only'

warehouse_only never calls platform APIs, including on empty data or warehouse errors.

granularity'auto' | 'account' | 'campaign'
limitinteger

Response

Customer metric summary

schema_version'ads_quant.customer_metric_summary.v1' required
status'customer_metric_summary_ready' required
operator_idstring
summaryobject required
date_windowobject required
account_summariesobject[] required
daily_totalsobject[] required
requestobject required
data_source_policyobject
query_interpretationobject
answer_contractobject
candidate_metric_guard_cnstring
hosted_auth_contextobject required

Changes

No recorded changes to this operation across all 1 revision of this API.