Retrieve individual cohort
curl --request GET \
--url 'https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k='import requests
url = "https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=', 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.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k="
req, _ := http.NewRequest("GET", url, nil)
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.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "38470a62-9837-4c86-bbf3-45dd6d52dd83",
"code": 12345,
"name": "Example Segment A",
"description": "This segment is an example for documentation purposes",
"query": {
"event": "Pageview",
"frequency": {
"greater_than_or_equal_to": 2
},
"where": {
"property": "properties.client.url",
"condition": {
"contains": "football"
}
},
"during": {
"the_last": {
"value": 30,
"unit": "days"
}
}
},
"tags": [
"tag_a",
"tag_b"
],
"state": "Enabled",
"segment_type": "real_time",
"live_audience_size": 10000,
"created_at": "2022-09-22T15:44:29.518393971Z",
"last_updated_at": "2022-09-22T15:44:29.518395049Z"
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"status_code": 400,
"status": "Bad Request",
"code": 1002,
"message": "The provided request body was not structured as expected.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"status_code": 401,
"status": "Unauthorized",
"code": 2005,
"message": "The supplied authentication is invalid.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"status_code": 403,
"status": "Forbidden",
"code": 2001,
"message": "The API key provided does not provide access to the request operation or resource.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"status_code": 404,
"status": "Not Found",
"code": 3000,
"message": "The requested resource does not exist.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.8",
"status_code": 409,
"status": "Conflict",
"code": 4000,
"message": "A resource with this identifier already exists.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
"status_code": 500,
"status": "Internal Server Error",
"code": 5000,
"message": "An error of unspecified nature was encountered while processing your request. Feel free to get in touch with us at support@permutive.com referencing the Request ID.",
"docs": "https://developer.permutive.com/reference#errors"
}
}Cohorts API
Retrieve individual cohort
This endpoint returns details of a single cohort belonging either to the workspace that owns the requesting API key, or to a parent workspace if the requesting workspace inherits the cohort from that workspace.
If the requested cohort is not a lookalike-based cohort, the response will include the query definition.
GET
/
v2
/
cohorts
/
{cohortId}
Retrieve individual cohort
curl --request GET \
--url 'https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k='import requests
url = "https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=', 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.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k="
req, _ := http.NewRequest("GET", url, nil)
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.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.permutive.app/cohorts-api/v2/cohorts/{cohortId}?k=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "38470a62-9837-4c86-bbf3-45dd6d52dd83",
"code": 12345,
"name": "Example Segment A",
"description": "This segment is an example for documentation purposes",
"query": {
"event": "Pageview",
"frequency": {
"greater_than_or_equal_to": 2
},
"where": {
"property": "properties.client.url",
"condition": {
"contains": "football"
}
},
"during": {
"the_last": {
"value": 30,
"unit": "days"
}
}
},
"tags": [
"tag_a",
"tag_b"
],
"state": "Enabled",
"segment_type": "real_time",
"live_audience_size": 10000,
"created_at": "2022-09-22T15:44:29.518393971Z",
"last_updated_at": "2022-09-22T15:44:29.518395049Z"
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"status_code": 400,
"status": "Bad Request",
"code": 1002,
"message": "The provided request body was not structured as expected.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"status_code": 401,
"status": "Unauthorized",
"code": 2005,
"message": "The supplied authentication is invalid.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"status_code": 403,
"status": "Forbidden",
"code": 2001,
"message": "The API key provided does not provide access to the request operation or resource.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"status_code": 404,
"status": "Not Found",
"code": 3000,
"message": "The requested resource does not exist.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.8",
"status_code": 409,
"status": "Conflict",
"code": 4000,
"message": "A resource with this identifier already exists.",
"docs": "https://developer.permutive.com/reference#errors"
}
}{
"request_id": "b887517b-99a2-4ae0-bc32-93d1fb13d1b7",
"error": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
"status_code": 500,
"status": "Internal Server Error",
"code": 5000,
"message": "An error of unspecified nature was encountered while processing your request. Feel free to get in touch with us at support@permutive.com referencing the Request ID.",
"docs": "https://developer.permutive.com/reference#errors"
}
}Authorizations
Path Parameters
Cohort UUID
Response
Cohort in full (including query)
- Option 1
- Option 2
Available options:
Enabled, Disabled - Option 1
- Option 2
⌘I