List segments
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.azimea.com/v1/segments"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.azimea.com/v1/segments';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.azimea.com/v1/segments \ --header 'Authorization: Bearer <token>'The company’s saved segments with their live counts: count is everyone the segment’s rule picks now, sendableCount those Azimea may email. Pass a segment’s id to GET /contacts?segment= to read its people. Needs contacts:read.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Every segment, with its rule and counts
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
object
The segment’s id. Use it as segment in GET /contacts.
The segment’s name.
A note about the segment; null when none was written.
The rules that decide who is in the segment.
object
All: a contact must match every rule. Any: matching one is enough.
The rules.
object
The field the rule looks at: a built-in field, or the key of one of your custom fields.
How the field is compared with the value.
What it is compared with. Its type follows the field: text, a number, a date, or a number of days.
A stable key for Azimea’s own segments; null for segments your team made.
How many contacts are in the segment now.
How many of them can receive marketing email, because they have a consent basis.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Example
{ "isSuccess": true, "value": [ { "id": "01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7f", "name": "Pro plan", "description": "Everyone on the pro plan.", "definition": { "join": "All", "rules": [ { "fieldKey": "plan", "operator": "Equals", "value": "pro" } ] }, "builtInKey": null, "count": 412, "sendableCount": 377 } ], "status": 0, "errors": [], "fieldErrors": null}Validation failed: see errors[].code and fieldErrors
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Example
{ "isSuccess": false, "value": null, "status": 5, "errors": [ { "code": "validation.required", "message": "Fill in this field.", "params": null } ], "fieldErrors": { "email": [ { "code": "validation.required", "message": "Fill in this field.", "params": null } ] }}Missing or invalid API key
The key lacks the contacts:read permission
Too many requests for this key