GET /v1/contacts/segments/{id}/usage
GET
/v1/contacts/segments/{id}/usage
const url = 'https://seu-endereco-da-api/v1/contacts/segments/example/usage';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://seu-endereco-da-api/v1/contacts/segments/example/usage \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler contatos (contacts:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
campaigns
required
Campanhas criadas a partir deste segmento
Array<object>
object
id
required
string
name
required
string
status
required
string
sequences
required
Sequencias em que este segmento inscreveu gente
Array<object>
object
id
required
string
name
required
string
enrolled
required
Quantas inscricoes vieram deste segmento
number
flows
required
Automacoes cujo gatilho por agendamento usa este segmento como publico, lido a cada disparo
Array<object>
object
id
required
string
name
required
string
Example generated
{ "campaigns": [ { "id": "example", "name": "example", "status": "example" } ], "sequences": [ { "id": "example", "name": "example", "enrolled": 1 } ], "flows": [ { "id": "example", "name": "example" } ]}