Dimensions

Get all dimensions added to the system

get

Authorizations

AuthorizationstringRequired

Responses

200

OK

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

get/v1/Dimensions

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

200

OK

[
  {
    "Uid": "2a2591ab-c2f0-4825-b15a-761c3cc3c9dd",
    "Alias": "Dimension 1",
    "Segments": [
      {
        "Uid": "c4b42eeb-e338-4b3a-a785-50efdb4dba6e",
        "Identifier": "Dimension 1 segment 1",
        "Name": "Dimension 1 segment 1"
      },
      {
        "Uid": "ba48569d-d759-44e7-8d44-112d95b7cda3",
        "Identifier": "Dimension 1 segment 2",
        "Name": "Dimension 1 segment 2"
      }
    ]
  },
  {
    "Uid": "709d6e04-2bd2-44df-bca4-ec4bbdd3b948",
    "Alias": "Dimension 2",
    "Segments": [
      {
        "Uid": "2bcd841c-99a8-4f45-9626-99b674bb7565",
        "Identifier": "Dimension 2 segment 1",
        "Name": "Dimension 2 segment 1"
      },
      {
        "Uid": "3c03486d-426f-4e7d-a9df-dd3bd15a94e8",
        "Identifier": "Dimension 2 segment 2",
        "Name": "Dimension 2 segment 2"
      }
    ]
  },
  {
    "Uid": "eab16f95-01d7-47dd-be10-9288fb889a49",
    "Alias": "Dimension 3",
    "Segments": [
      {
        "Uid": "6e86874f-b952-4860-993c-a84de8d24227",
        "Identifier": "Dimension 3 segment 1",
        "Name": "Dimension 3 segment 1"
      },
      {
        "Uid": "99c4ddfd-b4e4-4bdf-a2f2-24b13f1de189",
        "Identifier": "Dimension 3 segment 2",
        "Name": "Dimension 3 segment 2"
      }
    ]
  }
]

Add dimension to system

post

Authorizations

AuthorizationstringRequired

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

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

400

Bad Request

application/json

post/v1/Dimensions

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

{
  "Uid": "384f19e9-5075-4cb7-99ee-3f5f8c2fd50c",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "23694c2b-1283-4b3c-8d9a-852bdd197fea",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "fb223cac-3239-4210-aad3-ce46fd353c5f",
      "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

AuthorizationstringRequired

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

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

put/v1/Dimensions

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

{
  "Uid": "2f6d3e4d-fc71-4227-a88e-de62bd5ff560",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "d0b389d2-de72-4d77-bcce-84385431cf25",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "22c997ca-71b8-49f9-b1f3-4a53009aae2d",
      "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

AuthorizationstringRequired

Query parameters

uidstring · uuidOptional

Uid of dimension

Responses

200

OK

No content

delete/v1/Dimensions

DELETE /v1/Dimensions HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get a specific dimension in the system

get

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Uid of dimension

Responses

200

OK

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

404

Not Found

application/json

get/v1/Dimensions/{uid}

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

{
  "Uid": "000d35d2-da49-4607-84e8-614a570ea26e",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "c559fbbb-5126-47d0-88c4-692512223724",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "d7d21a2b-f337-483b-9d6e-55303b44ddb9",
      "Identifier": "Dimension 1 segment 2",
      "Name": "Dimension 1 segment 2"
    }
  ]
}