Jump to

• Request
• Response
• Examples

Retrieve a contact segment

get

/api/rest/2.0/assets/contact/segment/{id}

Retrieves the contact segment specified by the id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Id of the contact segment.

Query Parameters

• depth: 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ContactSegment

Type: object

Title: ContactSegment

Show Source

• count: string
  The number of contacts in the contact segment. This is a read-only property.
• createdAt: string
  Read Only: true

  The date and time the contact segment was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the contact segment.
• currentStatus: string
  This property is not used for contact segments.
• dependencyName: string
  Segment_Field_DependencyName_Description
• depth: 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: string
  This property is not used for contact segments.
• elements: array elements
  Array of contact segment elements.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the contact segment.
• id: string
  Read Only: true

  Id of the contact segment. This is a read-only property.
• isStale: string
  Whether or not the contact segment has been refreshed in the last 24 hours by the user performing the request.
• lastCalculatedAt: string
  The date and time of the most recent calculation. This is a read-only property.
• name: string
  The contact segment's name.
• permissions: array permissions
  The permissions for the contact segment granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used for contact segments.
• sourceTemplateId: string
  This property is not used for contact segments.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the contact segment was last updated.
• updatedBy: 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":"This property is not used for contact segments."
        },
        "name":{
            "type":"string",
            "description":"The contact segment's name."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for contact segments."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the contact segment granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the contact segment."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for contact segments."
        },
        "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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for contact segments."
        },
        "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/SegmentElementRest20"
            }
        },
        "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."
        },
        "isStale":{
            "type":"string",
            "description":"Whether or not the contact segment has been refreshed in the last 24 hours by the user performing the request."
        },
        "dependencyName":{
            "type":"string",
            "description":"Segment_Field_DependencyName_Description"
        }
    }
}

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/SegmentElementRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the contact segment granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the contact segment granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : SegmentElement

Type: object

Title: SegmentElement

Show Source

• count: string
  The number of contacts in the contact segment element. This is a read-only property.
• createdAt: string
  Read Only: true

  The date and time the contact segment element was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the contact segment element.
• currentStatus: string
  The contact segment element's current status. This is a read-only property.
• depth: 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: string
  This property is not used for contact segment elements.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the contact segment element.
• id: string
  Read Only: true

  Id of the contact segment element. This is a read-only property.
• isIncluded: string
  The total amount of contacts within the segment element.
• lastCalculatedAt: string
  The date and time the contact segment element was last calculated. This is a read-only property.
• name: string
  This property is not used for contact segment elements.
• permissions: array permissions
  The permissions for the contact segment element granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used for contact segment elements.
• sourceTemplateId: string
  This property is not used for contact segment elements.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the contact segment element was last updated.
• updatedBy: 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":"This property is not used for contact segment elements."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for contact segment elements."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the contact segment element granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the contact segment element."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for contact segment elements."
        },
        "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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for contact segment elements."
        },
        "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."
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the contact segment element granted to your current instance. This is a read-only property.",
    "items":{
        "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.

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 contact segment whose Id is 70:

GET /api/REST/2.0/assets/contact/segment/70
Content-Type: application/json
			

Response:

{
  "type": "ContactSegment",
  "currentStatus": "Draft",
  "id": "70",
  "createdAt": "1501002060",
  "createdBy": "9",
  "depth": "complete",
  "folderId": "1267",
  "name": "My new segment name",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update"
  ],
  "updatedAt": "1501002674",
  "updatedBy": "9",
  "elements": [],
  "isStale": "True"
}
			

Back to Top