Get Audiences

curl --request GET \
  --url https://api.audiencelab.io/audiences \
  --header 'X-Api-Key: <api-key>'

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

fetch('https://api.audiencelab.io/audiences', 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.audiencelab.io/audiences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <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.audiencelab.io/audiences"

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

	req.Header.Add("X-Api-Key", "<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.audiencelab.io/audiences")

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

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

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

{
  "total_records": 50,
  "page_size": 100,
  "page": 1,
  "total_pages": 1,
  "data": [
    {
      "id": "aa1a0c14-2dff-4389-b025-06a308df9ee9",
      "name": "My Test Audience",
      "next_scheduled_refresh": null,
      "scheduled_refresh": false,
      "refresh_interval": null,
      "webhook_url": null
    }
  ]
}

{
  "message": "error message"
}

{
  "message": "error message"
}

GET

audiences

Get Audiences

curl --request GET \
  --url https://api.audiencelab.io/audiences \
  --header 'X-Api-Key: <api-key>'

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

fetch('https://api.audiencelab.io/audiences', 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.audiencelab.io/audiences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <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.audiencelab.io/audiences"

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

	req.Header.Add("X-Api-Key", "<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.audiencelab.io/audiences")

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

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

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

{
  "total_records": 50,
  "page_size": 100,
  "page": 1,
  "total_pages": 1,
  "data": [
    {
      "id": "aa1a0c14-2dff-4389-b025-06a308df9ee9",
      "name": "My Test Audience",
      "next_scheduled_refresh": null,
      "scheduled_refresh": false,
      "refresh_interval": null,
      "webhook_url": null
    }
  ]
}

{
  "message": "error message"
}

{
  "message": "error message"
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

page

integer

default:1

Page number (1-indexed)

Required range: x >= 1

page_size

integer

default:100

Number of items per page (max 1000)

Required range: 1 <= x <= 1000

Response

Successfully retrieved audiences list

total_records

integer

Example:

50

page_size

integer

Example:

100

page

integer

Example:

1

total_pages

integer

Example:

1

data

object[]

Show child attributes

Audience

Enrichment

Pixel

Get Audiences

Authorizations

Query Parameters

Response