> ## Documentation Index > Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt > Use this file to discover all available pages before exploring further. # Ad-click landings and conversions, aggregated > Totals for a time range (default: the last 30 days; at most 400 days per request), grouped by any of the `groupBy` dimensions (none = one total row). Two sections: - **landings** — page views whose URL carried an ad click ID, from the Request Log (every visitor counts; nothing identifying is used). Empty while the Request Log is switched off. Only `day`, `platform` (`google`, `meta`, `tiktok`, `other`), `utmSource`, `utmCampaign` and `landingPath` apply. - **conversions** — conversion events by when they happened. Always also grouped by `currency`. `value` sums restated values and leaves out retracted events. Grouped by `platform` (a destination such as `google-ads`), each row adds browser and server delivery outcomes — the delivery success rate. Days are UTC. At most 5,000 rows per section. **Access:** an API key with `ads-metrics:read` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `analytics:view` permission. Anonymous callers get 404. **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /ads-metrics openapi: 3.1.0 info: title: Fetchski Attract CMS API description: >- Auto-generated OpenAPI spec for this Fetchski site instance. Authenticate machine-to-machine requests with an API key by sending the header `Authorization: ApiKey `. Keys are issued in the CMS (API Keys) and carry scopes that limit them to specific actions. Each key also has its own security policy, chosen when it is created: a signing mode (token only, signed writes, or every request signed with the key’s signing secret via `X-Fetchski-Timestamp` + `X-Fetchski-Signature`), an optional network allowlist, and reads/writes-per-minute limits (429 with `Retry-After` over them). Some routes require a signature from every key — see each route. version: 1.0.0 servers: - url: https://{host}/api/v1 description: 'Your site: set `host` to its host name.' variables: host: default: acme.example security: [] tags: - name: Authentication description: >- Sign in as a person to get a bearer token or a session cookie. Integrations use an API key instead: send `Authorization: ApiKey `. - name: SDK Packages description: >- The site’s own npm registry and Composer repository for the Attract SDKs, so an app installs them with one of the site’s API keys. Point npm, pnpm, Bun or Composer at them; the SDKs never call them. - name: Pages description: 'The page tree: each page’s content, place and URL.' - name: Global Content description: Site-wide content and settings every page shares. - name: Redirects description: Old URLs and where they now send visitors. - name: Internationalization description: The site’s locales. - name: Languages description: >- The site’s languages: the main language’s name and every further language’s name, code and Public switch. A save applies at once: a new language gets its home page and its own addresses (/fr/…), and its pages are then translated with each type’s localize routes. - name: Page Templates description: >- The site’s whole-page starting arrangements. They are not pages of the site (the Pages list leaves them out for API keys): read one, then make a page from it with Pages → create and `_copyingId` (`copyingId` in the SDKs). - name: Blog Posts description: The blog’s posts, and importing them from Markdown or MDX. - name: Blog Categories description: The categories posts are filed under. - name: Authors description: The people posts are credited to. - name: Team Members description: The people the Team section shows. - name: Testimonials description: Quotes from customers. - name: FAQ Items description: Questions and their answers. - name: FAQ Categories description: The groups questions are sorted into. - name: Google Reviews description: Reviews from the business’s Google profile, synced on a schedule. - name: Instagram Posts description: Posts from the connected Instagram account, synced on a schedule. - name: Service Areas description: The places the business serves, for the service map. - name: Cookies description: The cookies the consent banner declares. - name: Media description: The Images and Files libraries, and their tags. - name: Videos description: The Videos library. - name: Image Folders description: The folders that organize the Images library. - name: File Folders description: The folders that organize the Files library. - name: Video Folders description: The folders that organize the Videos library. - name: Photo Albums description: Hand-picked, ordered sets of photos for galleries. - name: Photo Feeds description: >- Feeds that collect photos from a connected photo source into the Images library on a schedule. - name: Attachments description: Uploading files and cropping images. - name: Fetchski Media description: >- Read-only discovery over the Images and Videos libraries: find what to reference in an MDX blog import, or which file to use, with its URLs. - name: Forms description: The site’s forms and their fields. - name: Form Submissions description: >- What visitors sent through the site’s forms. Submissions hold personal details: give a key `forms:read` only where it is needed. - name: Conversion Events description: >- The conversion event log — one record per conversion, with its attribution and consent snapshot and its delivery to each ad platform. Read it incrementally, post facts from other systems (a reservation purchase, a lead outcome), and adjust them (refunds, cancellations). One event ID travels everywhere as the platforms’ de-duplication key. - name: Visitor Attribution description: >- Per-visitor attribution on this site: first touch, last ad or campaign touch, and the ad platforms’ browser IDs. The join other systems use to attach a purchase to the marketing-site journey that led to it. - name: Ads Metrics description: >- Aggregates for dashboards: ad-click landings and conversions, by day, platform, campaign and more. - name: Conversions description: >- Conversion definitions — the visitor actions (a lead, a call click, a booking, a purchase) this site reports to the ad platforms, each with a row per platform. Managed by administrators in the CMS. - name: Webhooks description: >- Push notifications of form submissions and conversion-event changes to the site’s Webhook Destinations — signed with each destination’s own secret, retried for a day, at-least-once. Set destinations up in the CMS (Webhook Destinations, for people granted “Manage webhook destinations”): URL, events, optional filters and custom headers, and the signing secret shown once. - name: Request Log description: >- The page views the site captured (Connections → Tracking → Request log), and the query parameters on them: campaign tags and ad click IDs. paths: /ads-metrics: get: tags: - Ads Metrics summary: Ad-click landings and conversions, aggregated description: >- Totals for a time range (default: the last 30 days; at most 400 days per request), grouped by any of the `groupBy` dimensions (none = one total row). Two sections: - **landings** — page views whose URL carried an ad click ID, from the Request Log (every visitor counts; nothing identifying is used). Empty while the Request Log is switched off. Only `day`, `platform` (`google`, `meta`, `tiktok`, `other`), `utmSource`, `utmCampaign` and `landingPath` apply. - **conversions** — conversion events by when they happened. Always also grouped by `currency`. `value` sums restated values and leaves out retracted events. Grouped by `platform` (a destination such as `google-ads`), each row adds browser and server delivery outcomes — the delivery success rate. Days are UTC. At most 5,000 rows per section. **Access:** an API key with `ads-metrics:read` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `analytics:view` permission. Anonymous callers get 404. **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. operationId: getAdsMetrics parameters: - name: from in: query required: false description: >- Start (inclusive), ISO 8601 date or time. Default: 30 days before `to`. schema: type: string format: date-time - name: to in: query required: false description: 'End (exclusive), ISO 8601 date or time. Default: now.' schema: type: string format: date-time - name: groupBy in: query required: false description: Comma-separated dimensions, or the parameter repeated. style: form explode: false schema: type: array items: type: string enum: - day - conversion - platform - utmSource - utmCampaign - landingPath uniqueItems: true example: - day - platform responses: '200': description: The aggregates. content: application/json: schema: $ref: '#/components/schemas/AdsMetricsResponse' example: from: '2026-09-01T00:00:00.000Z' to: '2026-09-22T00:00:00.000Z' groupBy: - day - platform landings: groupBy: - day - platform rows: - key: day: '2026-09-20' platform: google landings: 41 conversions: groupBy: - day - platform rows: - key: currency: USD day: '2026-09-20' platform: google-ads conversions: 3 retracted: 0 value: 6400 browserSent: 2 serverSent: 3 serverPending: 0 serverFailed: 0 serverSkipped: 0 '400': $ref: '#/components/responses/DataApiInvalid' '401': $ref: '#/components/responses/DataApiUnauthorized' '403': $ref: '#/components/responses/DataApiForbidden' '404': $ref: '#/components/responses/DataApiNotFound' '429': $ref: '#/components/responses/DataApiRateLimited' security: - ApiKeyAuth: - ads-metrics:read x-codeSamples: - lang: typescript label: TypeScript source: |- import { createSiteClient } from '@fetchski/attract-cms-sdk'; const site = createSiteClient(); const adsMetrics = await site.adsMetrics().getAdsMetrics(); - lang: php label: Laravel source: |- use Fetchski\AttractCmsLaravel\Facades\Attract; $adsMetrics = Attract::adsMetrics()->getAdsMetrics(); components: schemas: AdsMetricsResponse: type: object required: - from - to - groupBy - landings - conversions properties: from: type: string format: date-time description: The window’s start (inclusive). to: type: string format: date-time description: The window’s end (exclusive). groupBy: type: array items: type: string enum: - day - conversion - platform - utmSource - utmCampaign - landingPath description: The dimensions asked for. landings: type: object description: >- Page views whose URL carried an ad click ID (from the Request Log — empty while it is switched off). Grouped only by day, platform (`google`, `meta`, …), utmSource, utmCampaign and landingPath. properties: groupBy: type: array items: type: string description: >- The dimensions applied here (the asked-for ones a page view has). rows: type: array description: One per group, sorted by key (at most 5,000). items: $ref: '#/components/schemas/AdsMetricsResponseLandingsRowsItem' conversions: type: object description: >- Conversion events. `value` sums restated values and leaves out retracted events. Grouped by platform (a destination such as `google-ads`), each row adds delivery outcomes. properties: groupBy: type: array items: type: string description: The dimensions applied here. rows: type: array description: One per group (and currency), sorted by key (at most 5,000). items: $ref: '#/components/schemas/AdsMetricsResponseConversionsRowsItem' AdsMetricsResponseLandingsRowsItem: type: object required: - key - landings properties: key: $ref: '#/components/schemas/AdsMetricsKey' landings: type: integer minimum: 0 description: Page views with an ad click id. AdsMetricsResponseConversionsRowsItem: type: object required: - key - conversions - retracted - value properties: key: $ref: '#/components/schemas/AdsMetricsKey' conversions: type: integer minimum: 0 description: Events not retracted. retracted: type: integer minimum: 0 description: Events retracted. value: type: number description: Their value, restated values counted, retracted ones left out. browserSent: type: integer minimum: 0 description: 'Grouped by platform: events the page’s tag sent to it.' serverSent: type: integer minimum: 0 description: 'Grouped by platform: delivered by the server.' serverPending: type: integer minimum: 0 description: 'Grouped by platform: owed by the server (`queued` or `retry`).' serverFailed: type: integer minimum: 0 description: 'Grouped by platform: server sends that failed.' serverSkipped: type: integer minimum: 0 description: not-configured, expired, not-sent or no-consent. DataApiError: type: object description: >- Every error. `name` → HTTP status: `invalid` 400, `invalid`/`unauthorized` 401, `forbidden` 403, `notfound` 404, `conflict` 409, `tooManyRequests` 429. required: - name - message properties: name: type: string enum: - invalid - unauthorized - forbidden - notfound - conflict - tooManyRequests - error message: type: string data: type: object properties: errors: type: array items: $ref: '#/components/schemas/DataApiFieldError' description: Present on 400. retryAfter: type: integer description: Present on 429. eventId: type: string description: Present on 409. AdsMetricsKey: type: object description: >- The group this row totals; only the requested dimensions (and `currency`, for conversions) appear. properties: currency: type: string description: >- Conversions: the currency their `value` is in (rows never mix currencies); absent for events without one. day: type: string format: date description: UTC day. conversion: type: string description: 'Conversions: the Conversion’s id.' platform: type: string description: >- Conversions: a destination (e.g. `google-ads`, `meta`); landings: the ad platform of the click id (`google`, `meta`, `tiktok`, `other`). utmSource: type: string description: The `utm_source` of the visit; absent when it had none. utmCampaign: type: string description: The `utm_campaign` of the visit; absent when it had none. landingPath: type: string description: >- The page the visit landed on (for a conversion: its last touch, else its first). DataApiFieldError: type: object required: - name - message properties: name: type: string example: invalid code: type: integer example: 400 path: type: string description: The query parameter or body field (dotted) the problem is in. example: match.emailSha256 message: type: string data: type: object responses: DataApiInvalid: description: >- The request is not valid. `data.errors` lists each problem with the `path` of the parameter or body field it concerns. content: application/json: schema: $ref: '#/components/schemas/DataApiError' example: name: invalid message: The query is not valid. data: errors: - name: invalid code: 400 path: limit message: A whole number from 1 to 500. data: {} DataApiUnauthorized: description: >- The API key is missing, malformed, unknown, disabled, expired or archived (`invalid`), or a request that must be signed — by the route, or by the key’s own signing mode — has a missing, stale or wrong signature (an upload signs its SHA-256, declared in `X-Fetchski-Content-SHA256`, in the body’s place) (`unauthorized`). content: application/json: schema: $ref: '#/components/schemas/DataApiError' example: name: unauthorized message: X-Fetchski-Signature does not match this request. data: {} DataApiForbidden: description: >- The API key lacks the scope this route needs (the message names it), or the key is used from an address outside its allowlist. content: application/json: schema: $ref: '#/components/schemas/DataApiError' example: name: forbidden message: 'This API key lacks the required scope: conversions:read.' data: {} DataApiNotFound: description: >- Nothing with this identifier — or the caller may not use the Data API at all (anonymous visitors and non-admin sessions get 404 so the API is not advertised). A write while conversion tracking is switched off also answers 404. content: application/json: schema: $ref: '#/components/schemas/DataApiError' example: name: notfound message: No event with this ID. data: {} DataApiRateLimited: description: >- The key used up its reads- or writes-per-minute limit (set per key; defaults 600 / 120). Wait `Retry-After` seconds. headers: Retry-After: description: Seconds until the budget resets. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/DataApiError' example: name: tooManyRequests message: This API key’s rate limit is used up for this minute. data: retryAfter: 12 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Paste your API key as the CMS showed it: `fsk___` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.