Dimensions

Get all dimensions added to the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/Dimensions

HTTPcURLJavaScriptPython

GET /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "856d023f-2f19-4dcd-93f1-28b70e19d253",
    "Alias": "Dimension 1",
    "Segments": [
      {
        "Uid": "6c5a3d68-f518-477e-8dfd-76dbae9443d1",
        "Identifier": "Dimension 1 segment 1",
        "Name": "Dimension 1 segment 1"
      },
      {
        "Uid": "58629599-9e34-448e-bcb8-c0ab4fcac1fa",
        "Identifier": "Dimension 1 segment 2",
        "Name": "Dimension 1 segment 2"
      }
    ]
  },
  {
    "Uid": "f3189b8c-6c13-435e-b169-2facc252cf1a",
    "Alias": "Dimension 2",
    "Segments": [
      {
        "Uid": "04af7fec-313a-439e-99a2-b7c235dcf3fc",
        "Identifier": "Dimension 2 segment 1",
        "Name": "Dimension 2 segment 1"
      },
      {
        "Uid": "a94c0a57-565c-4d48-a577-c14b8523fcd6",
        "Identifier": "Dimension 2 segment 2",
        "Name": "Dimension 2 segment 2"
      }
    ]
  },
  {
    "Uid": "ed3fe79b-15b6-4d3c-b953-79863f8d76c4",
    "Alias": "Dimension 3",
    "Segments": [
      {
        "Uid": "cc39bd29-6512-4a8d-8aae-b3fc5a5ee987",
        "Identifier": "Dimension 3 segment 1",
        "Name": "Dimension 3 segment 1"
      },
      {
        "Uid": "e6592786-5b03-4da1-9bbf-5686e39ed277",
        "Identifier": "Dimension 3 segment 2",
        "Name": "Dimension 3 segment 2"
      }
    ]
  }
]

Add dimension to system

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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

application/json

400

Bad Request

application/json

post

/v1/Dimensions

HTTPcURLJavaScriptPython

POST /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "Uid": "d074f44d-0614-49d7-aa6a-17a9513b61db",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "605109b4-b6f0-4f24-8254-554e5de7e883",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "e2824e86-73a5-4ece-8360-6c24e12e597a",
      "Identifier": "Dimension 1 segment 2",
      "Name": "Dimension 1 segment 2"
    }
  ]
}

{
  "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

ApiKey

AuthorizationstringRequired

Body

application/json

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

application/json

put

/v1/Dimensions

HTTPcURLJavaScriptPython

PUT /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "Uid": "c5180238-4573-485b-a490-67584ff41c88",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "7f6ded56-1865-4f2c-a605-105cf0c879a8",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "f0066470-542f-410c-a48a-b6c317ebd711",
      "Identifier": "Dimension 1 segment 2",
      "Name": "Dimension 1 segment 2"
    }
  ]
}

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

ApiKey

AuthorizationstringRequired

Query parameters

uidstring · uuidOptional

Uid of dimension

Responses

200

OK

No content

delete

/v1/Dimensions

HTTPcURLJavaScriptPython

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

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Uid of dimension

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/Dimensions/{uid}

HTTPcURLJavaScriptPython

GET /v1/Dimensions/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "777e4e57-250c-4491-95d6-f90898cab863",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "14a40ab0-2c5d-4ec7-9cc1-587b3360b970",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "3f60895c-d60b-4a82-ad1f-708c01d2d07c",
      "Identifier": "Dimension 1 segment 2",
      "Name": "Dimension 1 segment 2"
    }
  ]
}