> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adside.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Conversion-mapping get

> Read the primary conversion mapping and optional suggested events

CLI: `adside reporting conversion-mapping get`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/reporting/conversion-mapping
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/reporting/conversion-mapping:
    get:
      tags:
        - Reporting
      summary: Conversion-mapping get
      description: |-
        Read the primary conversion mapping and optional suggested events

        CLI: `adside reporting conversion-mapping get`
      operationId: reporting.conversion-mapping.get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: suggestions
          in: query
          required: false
          schema:
            default: '1'
            type: string
            enum:
              - '0'
              - '1'
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  mapping:
                    anyOf:
                      - type: object
                        properties:
                          label:
                            default: Conversions
                            type: string
                            minLength: 1
                            maxLength: 60
                          metaActionTypes:
                            default: []
                            maxItems: 20
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 256
                          googleActionNames:
                            default: []
                            maxItems: 20
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 256
                          tiktokEventKeys:
                            default: []
                            maxItems: 20
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 256
                          linkedinEventKeys:
                            default: []
                            maxItems: 20
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 256
                          snapchatEventKeys:
                            default: []
                            maxItems: 20
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 256
                          redditEventKeys:
                            default: []
                            maxItems: 20
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 256
                          id:
                            type: string
                          isPrimary:
                            type: boolean
                        required:
                          - label
                          - metaActionTypes
                          - googleActionNames
                          - tiktokEventKeys
                          - linkedinEventKeys
                          - snapchatEventKeys
                          - redditEventKeys
                          - id
                          - isPrimary
                        additionalProperties: false
                      - type: 'null'
                  suggestion:
                    anyOf:
                      - type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      - type: 'null'
                required:
                  - mapping
                  - suggestion
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.