Query
query Segmentation($id: SegmentationId!) {
segmentation(id: $id) {
createdAt
fields
filter {
createdAt
id
name
namespace {
apiKeys {
__typename
}
avatar
avatarThumbnail
createdAt
description
id
}
resourceName
source {
catalogAsset {
__typename
}
createdAt
credential {
__typename
}
description
filters {
__typename
}
id
}
}
id
name
namespace {
apiKeys {
apiKey {
__typename
}
roleConfig {
__typename
}
}
avatar
avatarThumbnail
createdAt
description
id
}
}
}Variables
{
"id": "value"
}Response
{
"data": {
"segmentation": {
"createdAt": "value",
"fields": [
"string"
],
"filter": {
"createdAt": "value",
"id": "value",
"name": "string",
"namespace": {
"apiKeys": [
{
"__typename": "ApiKeyRole"
}
],
"avatar": "value",
"avatarThumbnail": "value",
"createdAt": "value",
"description": "string",
"id": "value"
},
"resourceName": "string",
"source": {
"catalogAsset": {
"__typename": "CatalogAsset"
},
"createdAt": "value",
"credential": {
"__typename": "Credential"
},
"description": "string",
"filters": [
{
"__typename": "Filter"
}
],
"id": "value"
}
},
"id": "value",
"name": "string",
"namespace": {
"apiKeys": [
{
"apiKey": {
"__typename": "ApiKey"
},
"roleConfig": {
"__typename": "NamespaceRoleConfig"
}
}
],
"avatar": "value",
"avatarThumbnail": "value",
"createdAt": "value",
"description": "string",
"id": "value"
}
}
}
}Queries
segmentation
Get a segmentation. Requires SEGMENTATIONS_READ permissions.
QUERY
segmentation(id: SegmentationId!): SegmentationArguments
id
SegmentationId!
required
Returns
createdAt
DateTime!
When the segmentation was created.
fields
[String!]!
Fields that should be grouped by value to create a segment, e.g. if fields are Country
and Vehicle a count result might look like this:
| Sweden | Car | 2 | | Sweden | Bike | 4 | | Norway | Car | 3 | | Norway | Bike | 1 | | Finland | Boat | 2 |
Whereas a segmentation on only Country would've resulted in this:
| Sweden | 6 | | Norway | 4 | | Finland | 2 |
filter
id
SegmentationId!
Segmentation identifier.
name
String!
The display name of the segmentation.
namespace
resourceName
String!
The resource name of the segmentation.
segmentUsage
Represents the expected segment usage for this segmentation.
segments
Arguments
after
String
before
String
limit
Int
source
updatedAt
DateTime!
When the segmentation was last updated.
Query
query Segmentation($id: SegmentationId!) {
segmentation(id: $id) {
createdAt
fields
filter {
createdAt
id
name
namespace {
apiKeys {
__typename
}
avatar
avatarThumbnail
createdAt
description
id
}
resourceName
source {
catalogAsset {
__typename
}
createdAt
credential {
__typename
}
description
filters {
__typename
}
id
}
}
id
name
namespace {
apiKeys {
apiKey {
__typename
}
roleConfig {
__typename
}
}
avatar
avatarThumbnail
createdAt
description
id
}
}
}Variables
{
"id": "value"
}Response
{
"data": {
"segmentation": {
"createdAt": "value",
"fields": [
"string"
],
"filter": {
"createdAt": "value",
"id": "value",
"name": "string",
"namespace": {
"apiKeys": [
{
"__typename": "ApiKeyRole"
}
],
"avatar": "value",
"avatarThumbnail": "value",
"createdAt": "value",
"description": "string",
"id": "value"
},
"resourceName": "string",
"source": {
"catalogAsset": {
"__typename": "CatalogAsset"
},
"createdAt": "value",
"credential": {
"__typename": "Credential"
},
"description": "string",
"filters": [
{
"__typename": "Filter"
}
],
"id": "value"
}
},
"id": "value",
"name": "string",
"namespace": {
"apiKeys": [
{
"apiKey": {
"__typename": "ApiKey"
},
"roleConfig": {
"__typename": "NamespaceRoleConfig"
}
}
],
"avatar": "value",
"avatarThumbnail": "value",
"createdAt": "value",
"description": "string",
"id": "value"
}
}
}
}