View Segment List

GET /segment-lists/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/segment-lists/{id}

Retrieves the details of an Segment List that has previously been created if a valid identifier was provided.

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ segment-list ]
An array of all created items.
Segment List
Name
Description
colorstring
List color. Valid hex color code.


Example: #6d9382
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000001
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
descriptionstring
The more detailed description of the List. string[0 .. 2000]


Example: This is my first segmet list.
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000
itemsarray
The array of segment ids. array [1 .. 100]


Example: ["1000", "1001"]
namestring
The name of the Segment List. string[2 .. 100] characters.


Example: My List
sizenumber
List size indicates the number of items in the list.


Example: 10
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
400 - Bad Request
Arrow
Name
Description
codeinteger
Http response status code.


Example: 400
messagestring
The human readable message that describes how to deal with error.


Example: The request body is not valid.
titlestring
The error title.


Example: Bad request.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
titlestring
The error title.


Example: Internal server error.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
tip
1 If you don't know the id, list the Segment Lists to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 400
  • 500
{
  "total": 1,
  "items": [
    {
      "id": "1000",
      "company_id": "1000001",
      "name": "My List",
      "color": "#6d9382",
      "size": 10,
      "description": "This is my first segmet list.",
      "items": "[\"1000\", \"1001\"]",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}