Skip to main content

Fospha API

The Fospha API is a GraphQL endpoint for programmatic access to marketing performance data. The reference below is generated directly from the production schema and grouped by business domain.

Domains​

  • Marketing performance — row-level (marketingRecords) and pre-aggregated (marketingAggregate) marketing data, including dimensions, base metrics, attribution metrics, and computed KPIs.
  • Data readiness — pipeline status (marketingDataReadiness) for clients that need to poll before querying.
  • Incremental forecasting — saturation diagnostics and rolling spend/target windows (incrementalForecastingSummary) from the latest model run per segment.
  • Common objects — shared inputs (DateRangeInput, PaginationInput, StringFilter), response metadata (QueryMetadata, PaginationInfo), and enums (Currency, SortDirection) reused across every domain.

Conventions​

  • All monetary fields default to EUR when currency is omitted.
  • DateRangeInput is inclusive on both startDate and endDate; maximum span is 90 days.
  • Pagination defaults to page: 1, pageSize: 1000 (min 1000, max 5000).
  • Authentication is OAuth2 client_credentials against Cognito — see the OAuth guide for the token-exchange flow.