> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Get report type mapping suggestions > Returns the column expressions this report type's mapping parameters accept, as ordered suggestion groups of `column_name` / `expression` pairs. Where the schema endpoints describe the columns a report produces, this endpoint describes the expressions that can go into its column mapping parameters. Each `expression` is complete and ready to append to the parameter's `;`-separated `name=expression` mapping value. Suggestions are derived from the contracts the report executor resolves expressions against, so every suggestion resolves to a real value when the report runs. A report type whose mapping parameters have no suggestions yet, or which has no mapping parameters at all, returns an empty `parameters` list. ## OpenAPI ````yaml /api-reference/management.json get /v6/report-types/{id}/mapping-suggestions openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Operations - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v6/report-types/{id}/mapping-suggestions: get: tags: - Report Types summary: Get report type mapping suggestions description: >- Returns the column expressions this report type's mapping parameters accept, as ordered suggestion groups of `column_name` / `expression` pairs. Where the schema endpoints describe the columns a report produces, this endpoint describes the expressions that can go into its column mapping parameters. Each `expression` is complete and ready to append to the parameter's `;`-separated `name=expression` mapping value. Suggestions are derived from the contracts the report executor resolves expressions against, so every suggestion resolves to a real value when the report runs. A report type whose mapping parameters have no suggestions yet, or which has no mapping parameters at all, returns an empty `parameters` list. operationId: getReportTypeMappingSuggestions parameters: - description: The Extole unique report type identifier. in: path name: id required: true schema: type: string - description: >- Optional parameter name to narrow the response to a single mapping parameter. Rejected when the report type has no parameter with this name. in: query name: parameter schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportTypeMappingSuggestionsResponse' description: >- Mapping suggestions per mapping parameter of the report type, as ordered groups of complete column expressions. '400': content: application/json: examples: report_type_mapping_suggestion_parameter_not_found: $ref: >- #/components/examples/report_type_mapping_suggestion_parameter_not_found report_type_missing: $ref: '#/components/examples/report_type_missing' schema: $ref: '#/components/schemas/RestExceptionResponse' description: >- The request cannot be fulfilled. Either the report type id is missing from the request (`report_type_missing`), or the supplied `parameter` query does not name a parameter of this report type (`report_type_mapping_suggestion_parameter_not_found`) - inspect the response `code` field for the specific error. '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '404': content: application/json: examples: report_type_not_found: $ref: '#/components/examples/report_type_not_found' description: >- Report type was not found. The supplied id does not match any report type accessible to the calling client. '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: ReportTypeMappingSuggestionsResponse: properties: parameters: description: >- One entry per mapping parameter of the report type that has suggestions, in the report type's parameter order. Empty when the report type has no mapping parameters with suggestions - that is a valid answer, not an error. items: $ref: '#/components/schemas/ParameterMappingSuggestionsResponse' type: array report_type_id: description: Id of the report type these suggestions belong to. readOnly: true type: string required: - parameters - report_type_id type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object ParameterMappingSuggestionsResponse: properties: groups: description: Suggestion groups for this parameter, in display order. items: $ref: '#/components/schemas/MappingSuggestionGroupResponse' type: array parameter_name: description: >- Name of the report type parameter these suggestions apply to, e.g. `mappings`. Matches the `name` of an entry in the report type's `parameters` list. readOnly: true type: string parameter_type_name: description: >- Type of the parameter, e.g. `ROW_MAPPINGS`. Matches the parameter's `type.name` on the report type, so a client can key its editor off the type while binding suggestions to the parameter by name. enum: - AUDIENCE_ID - AUDIENCE_IDS - AUDIENCE_MEMBERSHIPS_METRIC_MAPPING - AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS - AUDIENCE_MEMBERS_ROW_MAPPINGS - BOOLEAN - CAMPAIGN_ID - CAMPAIGN_IDS - CHANNEL_MAPPING - CLIENT_EVENT_METRIC_MAPPINGS - CLIENT_ID - CLIENT_IDS - DATE - DATE_RANGE - DECIMAL - EMAIL_NAMES - ENUM - ENUM_LIST - EQUALITY - FILTER_MAPPINGS - FLOWS - FLOW_FILTER - GRANULAR_TIME_RANGE - ID - IDS - INPUT_RECORD_METRIC_MAPPING - INPUT_RECORD_ROW_MAPPINGS - INTEGER - LONG - MESSAGE_SUMMARY_METRIC_MAPPINGS - METRIC_MAPPINGS - MODEL_CONFIGURATION_METRIC_MAPPING - NORMALIZED_EMAIL - NOT_ARCHIVED_CAMPAIGN_ID - PERSON_DIMENSION_MAPPINGS - PERSON_MAPPINGS - PROGRAM_LABEL - PROGRAM_LABELS - REGEX - REWARD_EVENT_METRIC_MAPPINGS - REWARD_ROW_MAPPINGS - REWARD_SUPPLIER_DISPLAY_TYPES - REWARD_SUPPLIER_IDS - REWARD_SUPPLIER_TYPES - ROW_MAPPINGS - SORT_ORDER_MAPPINGS - SORT_ORDER_MAPPINGS_ON_STEPS - STEP - STEPS - STEP_COLUMN_LIST - STRING - STRING_LIST - TIERS - TIME - TIME_RANGE - WEBHOOK_DISPATCH_METRIC_MAPPING - WEBHOOK_DISPATCH_ROW_MAPPINGS - WEBHOOK_METRIC_MAPPING - WEBHOOK_ROW_MAPPINGS readOnly: true type: string required: - groups - parameter_name - parameter_type_name type: object MappingSuggestionGroupResponse: properties: display_name: description: >- Human-readable group heading suitable for a picker, e.g. `Person Location`. readOnly: true type: string name: description: >- Stable identifier of this suggestion group, e.g. `event`, `person`, `campaign`. readOnly: true type: string suggestions: description: Suggestions in this group, in display order. items: $ref: '#/components/schemas/MappingSuggestionResponse' type: array required: - display_name - name - suggestions type: object MappingSuggestionResponse: properties: column_name: description: >- Default report column name for this suggestion - the left-hand side of the `name=expression` pair appended to the mapping parameter. Rename it freely; the `expression` determines the value. readOnly: true type: string expression: description: >- Complete, ready-to-use column expression. Append `columnName=expression` to the mapping parameter's `;`-separated value as-is - no prefix or wrapping is ever needed. readOnly: true type: string required: - column_name - expression type: object examples: report_type_mapping_suggestion_parameter_not_found: summary: report_type_mapping_suggestion_parameter_not_found value: code: report_type_mapping_suggestion_parameter_not_found http_status_code: 400 message: Report type does not have a parameter with the supplied name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_type_missing: summary: report_type_missing value: code: report_type_missing http_status_code: 400 message: Report type is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_type_not_found: summary: report_type_not_found value: code: report_type_not_found http_status_code: 400 message: Report type referenced by the component is not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````