> ## Documentation Index > Fetch the complete documentation index at: https://docs.mentionlab.io/llms.txt > Use this file to discover all available pages before exploring further. # Get ad placement mix by card format > Returns the share of sponsored ad placements per card format (provider-defined open set, e.g. 'product_card_v2', 'image_card_v2'); honors the active filters. ## OpenAPI ````yaml https://api.mentionlab.io/api/docs-json post /api/analytics/ads/formats openapi: 3.0.0 info: title: MentionLab Public API v0.5.8-rc description: '' version: 0.5.8-rc contact: {} servers: - url: https://api.mentionlab.io security: [] tags: [] paths: /api/analytics/ads/formats: post: tags: - Analytics - Ads summary: Get ad placement mix by card format description: >- Returns the share of sponsored ad placements per card format (provider-defined open set, e.g. 'product_card_v2', 'image_card_v2'); honors the active filters. operationId: ChatgptAdsController_getFormats parameters: - name: x-project-id in: header description: Project ID to specify the project context required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChatgptAdsFilterDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ChatgptAdsFormatsResponse' '400': description: >- The request failed validation — the body, query or path parameters are malformed or out of range. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: The request is missing valid authentication credentials. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '403': description: >- The authenticated principal lacks the required permission, or access to the requested organisation/project. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' components: schemas: ChatgptAdsFilterDto: type: object properties: startDate: type: string description: Start date (inclusive) example: '2025-01-01' endDate: type: string description: End date (inclusive) example: '2025-01-31' countries: description: Filter by country codes example: - BE - FR type: array items: type: string languages: description: Filter by language codes example: - en - fr type: array items: type: string models: description: Filter by AI models example: - gpt-4o - claude-3-5-sonnet type: array items: type: string queryIds: description: Filter by query IDs example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string hasSources: type: string description: >- Filter by source presence: "sources" (only with sources), "no_sources" (only without), "all" (no filter). Legacy true/false values are still accepted. enum: - all - sources - no_sources hasShopping: type: string description: >- Filter by shopping presence: "shopping" (only with shopping), "no_shopping" (only without), "all" (no filter). Legacy true/false values are still accepted. enum: - all - shopping - no_shopping hasAds: type: string description: >- Filter by sponsored-ad presence: "ads" (only with ads), "no_ads" (only without), "all" (no filter). Legacy true/false values are still accepted. enum: - all - ads - no_ads queryTagIds: description: Filter by query tag IDs (numeric — bigint column) example: - '42' type: array items: type: string execTagIds: description: Filter by execution tag IDs example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string queryTagGroupIds: description: >- Filter by query tag group IDs — matches rows carrying any tag filed under a selected group. Combines with queryTagIds per queryTagMode. example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string execTagGroupIds: description: >- Filter by execution tag group IDs — matches rows carrying any tag filed under a selected group. Combines with execTagIds per execTagMode. example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string queryTypes: type: array description: >- Filter by query type. Include "untyped" to also match queries without a type. Results from since-deleted queries are excluded when this filter is set. items: type: string enum: - comparative - informative - perception - untyped queryTagMode: type: string description: >- Query tag matching mode: "and" matches ALL tags (default, the dashboard's), "or" matches ANY tag. enum: - and - or execTagMode: type: string description: >- Execution tag matching mode: "and" matches ALL tags (default, the dashboard's), "or" matches ANY tag. enum: - and - or timezone: type: string deprecated: true description: >- Deprecated and ignored. Date bounds and buckets are always UTC. Accepted for backward compatibility only. example: UTC groupBy: type: string description: >- Row grouping level for entity results. "none" = one row per entity, "division" = one row per division (entities not in a division get their own row), "group" = one row per top-level group (divisions roll up into their group). Defaults to "none". enum: - none - division - group groupByEntityGroup: type: boolean description: >- Deprecated — use groupBy instead. true is equivalent to groupBy="group". deprecated: true example: false showAllEntities: type: boolean description: >- Include entities that have only ever been seen in a single AI response. These are mostly one-off extraction noise and are hidden by default. example: false formats: description: >- Filter ad placements by card format (provider-defined open set, e.g. 'product_card_v2', 'image_card_v2'). Scopes totalAds and the brand rows only; adRate and the response totals remain format-agnostic. example: - image_card_v2 type: array items: type: string ChatgptAdsFormatsResponse: type: object properties: totalAds: type: number description: >- Total ad cards (placements) in the filtered scope — a 5-card carousel weighs 5. example: 159 totalUnits: type: number description: >- Total ad units summed over the format groups — the denominator for each format share. A unit carrying more than one format counts once per format. example: 95 formats: description: >- Ad-format mix, unit-weighted, sorted by share descending. Honors the formats filter (a filtered breakdown sums to 100% within the selected formats, up to per-row rounding). type: array items: $ref: '#/components/schemas/ChatgptAdsFormatShare' required: - totalAds - totalUnits - formats ApiErrorResponse: type: object properties: statusCode: type: number description: HTTP status code of the error. example: 400 message: type: string description: >- Human-readable description of the error. Validation failures return an array of per-field validation errors instead of a single string. example: Validation failed error: type: string description: Short name of the HTTP error. example: Bad Request required: - statusCode ChatgptAdsFormatShare: type: object properties: format: type: string description: >- Ad card format, as the provider names it (open set, e.g. 'product_card_v2', 'image_card_v2'). Raw string, not normalized. example: product_card_v2 adCount: type: number description: >- Ad cards (placements) with this format in the filtered scope — a 5-card carousel weighs 5. Secondary density signal; the share is unit-based. example: 80 unitCount: type: number description: >- Ad units (distinct AI responses) that rendered at least one card of this format — a 5-card carousel weighs 1. example: 16 share: type: number description: >- Share of ad units — "when an ad shows, how often is it this format". Formula: (unitCount / totalUnits) × 100. Sums to 100% across formats, up to per-row rounding. example: 16.8 required: - format - adCount - unitCount - share ````