Dimensions

Get all dimensions added to the system

get
Authorizations
Responses
200

OK

application/json
get
/v1/Dimensions
GET /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "937c3e94-c9bd-4d37-a41a-3f4a98faf916",
    "Alias": "Dimension 1",
    "Segments": [
      {
        "Uid": "cbe54f8c-29df-4bc4-b816-7d8fe4da39bd",
        "Identifier": "Dimension 1 segment 1",
        "Name": "Dimension 1 segment 1"
      },
      {
        "Uid": "79c93ad1-ecf9-4887-a3fe-b4e94d19103c",
        "Identifier": "Dimension 1 segment 2",
        "Name": "Dimension 1 segment 2"
      }
    ]
  },
  {
    "Uid": "abcd6cb4-93ec-452d-8eca-b9ab9e947d8a",
    "Alias": "Dimension 2",
    "Segments": [
      {
        "Uid": "ad987f54-8cad-4d82-9661-be09c0b015f2",
        "Identifier": "Dimension 2 segment 1",
        "Name": "Dimension 2 segment 1"
      },
      {
        "Uid": "3e74086d-8c19-44b5-bdef-b8d475552d50",
        "Identifier": "Dimension 2 segment 2",
        "Name": "Dimension 2 segment 2"
      }
    ]
  },
  {
    "Uid": "2894dadf-21e2-45b3-bc69-55410ed1d24d",
    "Alias": "Dimension 3",
    "Segments": [
      {
        "Uid": "b0e14f3d-50a5-4188-8a15-94ce718e9974",
        "Identifier": "Dimension 3 segment 1",
        "Name": "Dimension 3 segment 1"
      },
      {
        "Uid": "fe11863c-e3c3-4749-ab5b-a174b37eeb9a",
        "Identifier": "Dimension 3 segment 2",
        "Name": "Dimension 3 segment 2"
      }
    ]
  }
]

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

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

{
  "Uid": "b3a79625-10e4-4a04-b75d-64f3c7e5765c",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "64215d01-0dfc-48b1-8cab-e3ed49b798ba",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "e1190e84-98de-4e8f-87a6-e75d766dbd16",
      "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
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
put
/v1/Dimensions
PUT /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "Uid": "c3d8ae21-b2f9-4bde-8a41-38e96e2cfee8",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "bc20169a-2bfa-45b2-ba37-f43c214a4561",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "990755ee-28cf-4362-b355-88a0bda9444b",
      "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
Query parameters
uidstring · uuidOptional

Uid of dimension

Responses
200

OK

No content
delete
/v1/Dimensions
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

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

{
  "Uid": "b05e03fe-0857-4494-a776-723429403ec6",
  "Alias": "Dimension 1",
  "Segments": [
    {
      "Uid": "4c508fa9-c33b-4f29-b6fb-3f7c2dfb3fba",
      "Identifier": "Dimension 1 segment 1",
      "Name": "Dimension 1 segment 1"
    },
    {
      "Uid": "08670a10-16e7-4d84-9719-c2d683e20813",
      "Identifier": "Dimension 1 segment 2",
      "Name": "Dimension 1 segment 2"
    }
  ]
}
PreviousCategoriesNextEnrichmentInsightSetups

Last updated