Dimensions

Get all dimensions added to the system

get
Authorizations
Responses
200
OK
get
GET /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Segments": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Identifier": "text",
        "Name": "text"
      }
    ]
  }
]

Add dimension to system

post
Authorizations
Body

Representation of a dimension to be used to segment attribute value data

Uidstring · uuidOptional

Unique id of dimension

Aliasstring | nullableOptional

Unique alias of dimension

Responses
200
OK
post
POST /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 155

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}
{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}

Update a dimension in the system

put
Authorizations
Body

Representation of a dimension to be used to segment attribute value data

Uidstring · uuidOptional

Unique id of dimension

Aliasstring | nullableOptional

Unique alias of dimension

Responses
200
OK
put
PUT /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 155

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}

Delete a dimension in the system

delete
Authorizations
Query parameters
uidstring · uuidOptional

Uid of dimension

Responses
200
OK
delete
DELETE /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get a specific dimension in the system

get
Authorizations
Path parameters
uidstring · uuidRequired

Uid of dimension

Responses
200
OK
get
GET /v1/Dimensions/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}
PreviousCategoriesNextExports