Get report type mapping suggestions

curl --request GET \
  --url https://api.extole.io/v6/report-types/{id}/mapping-suggestions \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v6/report-types/{id}/mapping-suggestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v6/report-types/{id}/mapping-suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/report-types/{id}/mapping-suggestions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/report-types/{id}/mapping-suggestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "parameters": [
    {
      "groups": [
        {
          "display_name": "<string>",
          "name": "<string>",
          "suggestions": [
            {
              "column_name": "<string>",
              "expression": "<string>"
            }
          ]
        }
      ],
      "parameter_name": "<string>",
      "parameter_type_name": "AUDIENCE_ID"
    }
  ],
  "report_type_id": "<string>"
}

Report Types

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.

GET

report-types

{id}

mapping-suggestions

Get report type mapping suggestions

curl --request GET \
  --url https://api.extole.io/v6/report-types/{id}/mapping-suggestions \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v6/report-types/{id}/mapping-suggestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v6/report-types/{id}/mapping-suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/report-types/{id}/mapping-suggestions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/report-types/{id}/mapping-suggestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "parameters": [
    {
      "groups": [
        {
          "display_name": "<string>",
          "name": "<string>",
          "suggestions": [
            {
              "column_name": "<string>",
              "expression": "<string>"
            }
          ]
        }
      ],
      "parameter_name": "<string>",
      "parameter_type_name": "AUDIENCE_ID"
    }
  ],
  "report_type_id": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

string

required

The Extole unique report type identifier.

Query Parameters

parameter

string

Optional parameter name to narrow the response to a single mapping parameter. Rejected when the report type has no parameter with this name.

Response

Mapping suggestions per mapping parameter of the report type, as ordered groups of complete column expressions.

parameters

object[]

required

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.

Show child attributes

report_type_id

string

required

read-only

Id of the report type these suggestions belong to.

⌘I

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Get report type mapping suggestions

Authorizations

Path Parameters

Query Parameters

Response