Audience poll

Polling endpoint gives the data response of global and detailed requests by given datacode

GET /audiences/poll

Audience poll

cURL

curl --request GET \
  --url https://api.kameleoon.com/audiences/poll \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kameleoon.com/audiences/poll"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kameleoon.com/audiences/poll', 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.kameleoon.com/audiences/poll",
  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: Bearer <token>"
  ],
]);

$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.kameleoon.com/audiences/poll"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kameleoon.com/audiences/poll")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/audiences/poll")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "data": {
    "startDateTime": "2023-11-07T05:31:56Z",
    "endDateTime": "2023-11-07T05:31:56Z",
    "globalStats": {
      "elementCount": 123,
      "conversions": 123,
      "convertedElementCount": 123,
      "conversionRate": 123,
      "revenue": 123,
      "averageRevenuePerElementCount": 123,
      "averageRevenuePerConversion": 123,
      "averageConversionPerElementCount": 123,
      "conversionRateEvolution": 123,
      "elementCountEvolution": 123,
      "revenueEvolution": 123,
      "averageRevenuePerElementCountEvolution": 123,
      "averageRevenuePerConversionEvolution": 123
    },
    "segmentStats": [
      {
        "segmentId": 123,
        "elementCount": 123,
        "conversions": 123,
        "convertedElementCount": 123,
        "conversionRate": 123,
        "revenue": 123,
        "averageRevenuePerElementCount": 123,
        "averageRevenuePerConversion": 123,
        "averageConversionPerElementCount": 123,
        "conversionRateEvolution": 123,
        "elementCountEvolution": 123,
        "revenueEvolution": 123,
        "averageRevenuePerElementCountEvolution": 123,
        "averageRevenuePerConversionEvolution": 123,
        "elementCountGapTotal": 123,
        "conversionsGapTotal": 123,
        "revenueGapTotal": 123,
        "averageRevenuePerConversionGapTotal": 123
      }
    ],
    "periodStats": [
      {
        "elementCount": 123,
        "conversions": 123,
        "convertedElementCount": 123,
        "conversionRate": 123,
        "revenue": 123,
        "averageRevenuePerElementCount": 123,
        "averageRevenuePerConversion": 123,
        "averageConversionPerElementCount": 123,
        "startDateTime": "2023-11-07T05:31:56Z",
        "endDateTime": "2023-11-07T05:31:56Z"
      }
    ],
    "breakdownData": {
      "usualBreakdownStats": {},
      "customDataStats": {}
    }
  },
  "errorDescription": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dataCode · string · required

Response

200

*/*

OK

status · enum<string>

Available options: ERROR, READY, WAITING, TIMEOUT

data · Detailed audience · object

Show child attributes

errorDescription · string