Segmente sind in Hublify gespeicherte Sammlungen von Filter, Sortierungen und Limits.
Statt direkt über fields zu filtern ist es möglich auch über die API nach zuvor gespeicherten Segmenten filtern zu lassen.
Das bietet den entscheidenen Vorteil, das Benutzer zur Laufzeit, sofern sie die entsprechenden Rechte haben, Segmente anpassen können und damit auch die API-Daten Einfluss nehmen können!
Informationen und Tutorials zu Segmenten in Hublify, gibt es hier: Filter & Segmente.
Segmente können für die Dataset API für die Endpunkte data_get und data_getList verwendet werden.
Parameter
Parameter | Description | Example |
---|---|---|
fields | Felder, die zurückgegeben werden sollen | |
segments | Ein Array von ein oder mehreren Segment-Labels, mit denen das Ergebnis gefiltert werden soll | |
sql | (optional) Um LIMITs oder ORDERs (Sortierung) der Abfrage hinzuzufügen |
Beispiel
data_getList
Folgendes Beispiel filter die person-list nach dem Segment "a_segment_label".
Url: https://{your hublify url}/api/eos_10/data_getList
Parameters
{
"dataset": "person",
"fields": [ "personid", "firstname", "lastname" ],
"segments": [ "a_segment_label" ]
}
Response
{
"data": [
{
"personid": "K00000001",
"firstname": "Luke",
"lastname": "Skywalker"
},
{
"personid": "K00000003",
"firstname": "Anakin",
"lastname": "Skywalker"
}
],
"status": true
}