REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a list of contact segments

get

/api/bulk/2.0/contacts/segments

Retrieves a list of contact segments.

Request

Supported Media Types

application/json
text/csv

Query Parameters

limit: integer
links: string
offset: integer
orderBy: string
q: string
totalResults: boolean

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : ContactSegmentSearchResponse

Type: object

Title: ContactSegmentSearchResponse

Show Source

count(optional): integer

Title: count
hasMore(optional): boolean

Title: hasMore
items(optional): array items

Title: items
limit(optional): integer

Title: limit
offset(optional): integer

Title: offset
totalResults(optional): integer(int64)

Title: totalResults

{
    "title":"ContactSegmentSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContactSegment"
            }
        },
        "limit":{
            "title":"limit",
            "description":"",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

Array of: object ContactSegment

Title: ContactSegment

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContactSegment"
    }
}

Nested Schema : ContactSegment

Type: object

Title: ContactSegment

Show Source

count(optional): integer

Title: count
createdAt(optional): string(date-time)

Title: createdAt
createdBy(optional): string

Title: createdBy
executedAt(optional): string(date-time)

Title: executedAt
name(optional): string

Title: name
statement(optional): string

Title: statement
updatedAt(optional): string(date-time)

Title: updatedAt
updatedBy(optional): string

Title: updatedBy
uri(optional): string

Title: uri

{
    "title":"ContactSegment",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "executedAt":{
            "format":"date-time",
            "title":"executedAt",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

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.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Examples

Retrieve a list of the first 2 contact segments:


GET/contacts/segments?limit=2

Response:


{
    "items":[
        {
            "name":"Untitled Segment",
            "count":0,
            "executedAt":"2015-05-05T18:37:14.7730000Z",
            "statement":"{{ContactSegment[2]}}",
            "uri":"/contacts/segments/2",
            "createdBy":"API.User",
            "createdAt":"2015-05-05T18:37:12.3900000Z",
            "updatedBy":"API.User",
            "updatedAt":"2015-05-05T18:37:14.8700000Z"
        },
        {
            "name":"Test Segment",
            "count":541,
            "executedAt":"2015-06-22T14:19:41.3070000Z",
            "statement":"{{ContactSegment[4]}}",
            "uri":"/contacts/segments/4",
            "createdBy":"API.User",
            "createdAt":"2015-06-22T14:19:26.4030000Z",
            "updatedBy":"API.User",
            "updatedAt":"2015-06-22T14:19:41.4300000Z"
        }
    ],
    "totalResults":3,
    "limit":2,
    "offset":0,
    "count":2,
    "hasMore":true
}