1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 2.0
  5. Contact segments

Retrieve a list of contact segments

get

/api/rest/2.0/assets/contact/segments

Retrieves all contact segments that match the criteria specified by the request parameters

Request

Supported Media Types
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
  • Unix timestamp for the date and time the contact segment was last updated.
  • Specifies the field by which list results are ordered.
  • Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
  • Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : QueryResultSegment
Type: object
Title: QueryResultSegment
Show Source
Nested Schema : elements
Type: array
Array of contact segment fields.
Show Source
Nested Schema : ContactSegment
Type: object
Title: ContactSegment
Show Source
Nested Schema : elements
Type: array
Array of contact segment elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment granted to your current instance. This is a read-only property.
Show Source
Nested Schema : SegmentElement
Type: object
Title: SegmentElement
Show Source
  • The number of contacts in the contact segment element. This is a read-only property.
  • Read Only: true
    The date and time the contact segment element was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the contact segment element.
  • The contact segment element's current status. This is a read-only property.
  • Read Only: true
    Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
  • This property is not used for contact segment elements.
  • Read Only: true
    The folder id of the folder which contains the contact segment element.
  • Read Only: true
    Id of the contact segment element. This is a read-only property.
  • The total amount of contacts within the segment element.
  • The date and time the contact segment element was last calculated. This is a read-only property.
  • This property is not used for contact segment elements.
  • permissions
    The permissions for the contact segment element granted to your current instance. This is a read-only property.
  • Read Only: true
    This property is not used for contact segment elements.
  • This property is not used for contact segment elements.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the contact segment element was last updated.
  • Read Only: true
    The login id of the user that last updated the contact segment element.
Nested Schema : permissions
Type: array
The permissions for the contact segment element granted to your current instance. This is a read-only property.
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve the first 3 contact segments in your database:


GET /api/REST/2.0/assets/contact/segments?count=3
Content-Type: application/json

Response:


{
  "elements": [
    {
      "type": "ContactSegment",
      "currentStatus": "Draft",
      "id": "70",
      "createdAt": "1501002060",
      "createdBy": "9",
      "depth": "minimal",
      "folderId": "1267",
      "name": "My new segment name",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1501002674",
      "updatedBy": "9"
    },
    {
      "type": "ContactSegment",
      "currentStatus": "Draft",
      "id": "67",
      "createdAt": "1492455370",
      "createdBy": "10",
      "depth": "minimal",
      "folderId": "1267",
      "name": "Modern Marketers",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1492455370",
      "updatedBy": "10"
    },
    {
      "type": "ContactSegment",
      "currentStatus": "Draft",
      "id": "4",
      "createdAt": "1420037733",
      "createdBy": "5",
      "depth": "minimal",
      "folderId": "1267",
      "name": "Oracle Employees",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1420488265",
      "updatedBy": "5"
    }
  ],
  "page": 1,
  "pageSize": 3,
  "total": 56
}
Back to Top