Sub-resources of segments

All available methods for the sub-resources of the resource segments.


Get a collection of segment records

Get information about all segment records on segments resource.
[badge-blue GET] /segments/{segment_id}/segment-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
segment_id string The unique id for the Segment Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
segment_records SegmentRecord[] List of segment records
total_items integer Count of all found segment records

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/segments/8dc1e66b44796af5cd377910e1/segment-records
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhDAxNmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 14:37:47 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "segment_records": [
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "83caed4c60c6be7e4392cc25ed"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "8ac73e466c82a03f67e2c64e0f"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "8ac1de4c60b6ccb6a6949bfd58"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "8ace1f490bb35a25144887c66b"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "86cb6f46241f84ed71478a3b69"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "89c8bf419c5eebeeac642a7149"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "80c50059eac02e7e8a5fd5e950"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "87c2505061c19fbccc19feb9c6"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "80cf90568229b9001d9404f19f"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "8acce05ee0fa49b342df20ddd9"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "89c9315e48f9e74147f5d19ef3"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "84c68153e332ae1c122cf427bf"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "83c3d15bc58f1943bf392e6ef4"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "82c02256aac92595aa67680e71"
      },
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "customer_id": "8ccd625bddf15011dbe8d99485"
      }
    ],
    "total_items": 15
  }
}