Recuperar uma lista de definições de segmento
Você pode recuperar uma lista de todas as definições de segmento para sua organização fazendo uma solicitação GET para o ponto de extremidade /segment/definitions
.
Formato da API
O ponto de extremidade /segment/definitions
dá suporte a vários parâmetros de consulta para ajudar a filtrar os resultados. Embora esses parâmetros sejam opcionais, seu uso é altamente recomendado para ajudar a reduzir a sobrecarga cara. Fazer uma chamada para esse endpoint sem parâmetros recuperará todas as definições de segmento disponíveis para sua organização. Vários parâmetros podem ser incluídos, separados por "E" comercial (&
).
GET /segment/definitions
GET /segment/definitions?{QUERY_PARAMETERS}
Parâmetros de consulta
Uma lista de parâmetros de consulta disponíveis.
Parâmetro | Descrição | Exemplo |
---|---|---|
start | Especifica o deslocamento inicial para as definições de segmento retornadas. | start=4 |
limit | Especifica o número de definições de segmento retornadas por página. | limit=20 |
page | Especifica a página a partir da qual os resultados das definições de segmento começarão. | page=5 |
sort | Especifica por qual campo classificar os resultados. É gravado no seguinte formato: [attributeName]:[desc/asc] . | sort=updateTime:desc |
evaluationInfo.continuous.enabled | Especifica se a definição do segmento é habilitada para streaming. | evaluationInfo.continuous.enabled=true |
Solicitação
A solicitação a seguir recuperará as duas últimas definições de segmento publicadas em sua organização.
Uma solicitação de amostra para recuperar uma lista de definições de segmento.
curl -X GET https://platform.adobe.io/data/core/ups/segment/definitions?limit=2 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com uma lista de definições de segmento para a organização especificada como JSON.
Uma resposta de amostra ao recuperar uma lista de definições de segmento.
{
"segments": [
{
"id": "3da8bad9-29fb-40e0-b39e-f80322e964de",
"schema": {
"name": "_xdm.context.profile"
},
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "segment",
"description": "",
"expression": {
"type": "PQL",
"format": "pql/json",
"value": "{PQL_EXPRESSION}"
},
"mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1573253640000,
"baselineTime": 1574327114,
"updateEpoch": 1575588309,
"updateTime": 1575588309000
},
{
"id": "ca763983-5572-4ea4-809c-b7dff7e0d79b",
"schema": {
"name": "_xdm.context.profile"
},
"imsOrgId": "{ORG_ID}",
"name": "test segment",
"description": "",
"expression": {
"type": "PQL",
"format": "pql/json",
"value": "{PQL_EXPRESSION}"
},
"mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1561073779000,
"baselineTime": 1574327114,
"updateEpoch": 1574327114,
"updateTime": 1574327114000
}
],
"page": {
"totalCount": 2,
"totalPages": 1,
"sortField": "creationTime",
"sort": "desc",
"pageSize": 2,
"limit": 100
},
"link": {}
}