REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a contact segment

get

/api/REST/1.0/assets/contact/segment/{id}

Retrieves the contact segment specified by the id parameter.

Request

Supported Media Types

application/json

Path Parameters

id: integer

Id of the contact segment.

Query Parameters

depth(optional): string

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.

Response

Supported Media Types

application/json

200 Response

Root Schema : ContactSegment

Type: object

Title: ContactSegment

Show Source

count(optional): string

The number of contacts in the contact segment. This is a read-only property.
createdAt(optional): string

Read Only: true

The date and time the contact segment was created, expressed in Unix time.
createdBy(optional): string

Read Only: true

The login id of the user who created the contact segment.
currentStatus(optional): string

The contact segment's current status. This is a read-only property.
depth(optional): string

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.
description(optional): string

The description of the contact segment.
elements(optional): array elements

Array of contact segment elements.
id(optional): string

Read Only: true

Id of the contact segment. This is a read-only property.
lastCalculatedAt(optional): string

The date and time of the most recent calculation. This is a read-only property.
name(optional): string

The contact segment's name.
permissions(optional): string

The permissions for the contact segment granted to your current instance. This is a read-only property.
type(optional): string

The asset's type in Eloqua. This is a read-only property.
updatedAt(optional): string

Read Only: true

Unix timestamp for the date and time the contact segment was last updated.
updatedBy(optional): string

Read Only: true

The login id of the user that last updated the contact segment.

{
    "title":"ContactSegment",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the contact segment. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The contact segment's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The contact segment's name."
        },
        "description":{
            "type":"string",
            "description":"The description of the contact segment."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the contact segment granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the contact segment."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the contact segment was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the contact segment."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the contact segment was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "elements":{
            "type":"array",
            "description":"Array of contact segment elements.",
            "items":{
                "$ref":"#/definitions/SegmentElementRest10"
            }
        },
        "count":{
            "type":"string",
            "description":"The number of contacts in the contact segment. This is a read-only property."
        },
        "lastCalculatedAt":{
            "type":"string",
            "description":"The date and time of the most recent calculation. This is a read-only property."
        }
    }
}

Nested Schema : elements

Type: array

Array of contact segment elements.

Show Source

Array of: object SegmentElement

Title: SegmentElement

{
    "type":"array",
    "description":"Array of contact segment elements.",
    "items":{
        "$ref":"#/definitions/SegmentElementRest10"
    }
}

Nested Schema : SegmentElement

Type: object

Title: SegmentElement

Show Source

count(optional): string

The number of contacts in the contact segment element. This is a read-only property.
createdAt(optional): string

Read Only: true

The date and time the contact segment element was created, expressed in Unix time.
createdBy(optional): string

Read Only: true

The login id of the user who created the contact segment element.
currentStatus(optional): string

The contact segment element's current status. This is a read-only property.
depth(optional): string

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.
description(optional): string

The description of the contact segment element.
id(optional): string

Read Only: true

Id of the contact segment element. This is a read-only property.
isIncluded(optional): string

The total amount of contacts within the segment element.
lastCalculatedAt(optional): string

The date and time the contact segment element was last calculated. This is a read-only property.
name(optional): string

The name of the contact segment element. This is a read-only property.
permissions(optional): string

The permissions for the contact segment element granted to your current instance. This is a read-only property.
type(optional): string

The asset's type in Eloqua. This is a read-only property.
updatedAt(optional): string

Read Only: true

Unix timestamp for the date and time the contact segment element was last updated.
updatedBy(optional): string

Read Only: true

The login id of the user that last updated the contact segment element.

{
    "title":"SegmentElement",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the contact segment element. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The contact segment element's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the contact segment element. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the contact segment element."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the contact segment element granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the contact segment element."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the contact segment element was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the contact segment element."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the contact segment element was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "isIncluded":{
            "type":"string",
            "description":"The total amount of contacts within the segment element."
        },
        "count":{
            "type":"string",
            "description":"The number of contacts in the contact segment element. This is a read-only property."
        },
        "lastCalculatedAt":{
            "type":"string",
            "description":"The date and time the contact segment element was last calculated. This is a read-only property."
        }
    }
}

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.

Examples

Retrieve the contact segment asset with Id #2:


GET /api/REST/1.0/assets/contact/segment/2?depth=complete

Response:


{
    "type":"ContactSegment",
    "currentStatus":"Draft",
    "id":"2",
    "createdAt":"1430851032",
    "createdBy":"19",
    "depth":"complete",
    "folderId":"312",
    "name":"Test Segment",
    "permissions":"fullControl",
    "updatedAt":"1430851034",
    "updatedBy":"19",
    "count":"0",
    "elements":[],
    "lastCalculatedAt":"1430851034"
}