Recuperación de una lista de definiciones de segmentos
Puede recuperar una lista de todas las definiciones de segmentos de su organización realizando una solicitud de GET al extremo /segment/definitions
.
Formato de API
El extremo /segment/definitions
admite varios parámetros de consulta para filtrar los resultados. Aunque estos parámetros son opcionales, se recomienda encarecidamente su uso para ayudar a reducir los costes generales. Si realiza una llamada a este punto final sin parámetros, recuperará todas las definiciones de segmentos disponibles para su organización. Se pueden incluir varios parámetros, separados por el símbolo et (&
).
GET /segment/definitions
GET /segment/definitions?{QUERY_PARAMETERS}
Parámetros de consulta
Una lista de parámetros de consulta disponibles.
Parámetro | Descripción | Ejemplo |
---|---|---|
start | Especifica el desplazamiento inicial para las definiciones de segmento devueltas. | start=4 |
limit | Especifica el número de definiciones de segmento devueltas por página. | limit=20 |
page | Especifica la página desde la que se iniciarán los resultados de las definiciones de segmentos. | page=5 |
sort | Especifica por qué campo ordenar los resultados. Está escrito en el siguiente formato: [attributeName]:[desc/asc] . | sort=updateTime:desc |
evaluationInfo.continuous.enabled | Especifica si la definición del segmento está habilitada para flujo continuo. | evaluationInfo.continuous.enabled=true |
Solicitud
La siguiente solicitud recuperará las dos últimas definiciones de segmento publicadas en su organización.
Una solicitud de ejemplo para recuperar una lista de definiciones de segmentos.
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}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con una lista de definiciones de segmento para la organización especificada como JSON.
Una respuesta de ejemplo al recuperar una lista de definiciones de segmentos.
{
"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": {}
}