REST API - Accessing Contact Segments

Version 2

    The REST API provides access to retrieve Contact Segments from your Eloqua install.

     

    Accessing Contact Segments

    • GET  /assets/contact/segment/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
      "type": "ContactSegment",
      "x_e10_isTemplate": "false",
      "x_e10_createdAt": "1358430045",
      "x_e10_createdBy": "340",
      "currentStatus": "Draft",
      "id": "3796",
      "createdAt": "1358430044",
      "createdBy": "340",
      "depth": "complete",
      "folderId": "312",
      "name": "Sample Segment",
      "permissions": "fullControl",
      "updatedAt": "1358430049",
      "updatedBy": "340",
      "count": "10",
      "elements": [
        {
          "type": "ContactFilterSegmentElement",
          "id": "3397",
          "depth": "complete",
          "count": "0",
          "isIncluded": "true",
          "lastCalculatedAt": "1358430045",
          "filter": {
            "type": "ContactFilter",
            "x_e10_isTemplate": "false",
            "x_e10_createdAt": "1358430045",
            "x_e10_createdBy": "340",
            "currentStatus": "Draft",
            "id": "103198",
            "createdAt": "1358430045",
            "createdBy": "340",
            "depth": "complete",
            "folderId": "51",
            "name": "Contact Field Criteria",
            "updatedAt": "1358430049",
            "updatedBy": "340",
            "count": "0",
            "criteria": [
              {
                "type": "ContactFieldCriterion",
                "id": "9207",
                "condition": {
                  "type": "DateValueCondition",
                  "operator": "notLess",
                  "value": {
                    "type": "NamedDate",
                    "isAnyYear": "false",
                    "value": "Today"
                  }
                },
                "fieldId": "100026"
              }
            ],
            "lastCalculatedAt": "1358430049",
            "scope": "local",
            "statement": "9207"
          }
        },
        {
          "type": "ContactFilterSegmentElement",
          "id": "3398",
          "depth": "complete",
          "count": "10",
          "isIncluded": "true",
          "lastCalculatedAt": "1358430045",
          "filter": {
            "type": "ContactFilter",
            "x_e10_isTemplate": "false",
            "x_e10_createdAt": "1358430045",
            "x_e10_createdBy": "340",
            "currentStatus": "Draft",
            "id": "103199",
            "createdAt": "1358430045",
            "createdBy": "340",
            "depth": "complete",
            "folderId": "51",
            "name": "Email Criteria",
            "updatedAt": "1358430049",
            "updatedBy": "340",
            "count": "10",
            "criteria": [
              {
                "type": "EmailClickThroughCriterion",
                "id": "9208",
                "activityRestriction": {
                  "type": "NumericValueCondition",
                  "operator": "notLess",
                  "value": "1"
                },
                "timeRestriction": {
                  "type": "DateValueCondition",
                  "operator": "withinLast",
                  "value": {
                    "type": "RelativeDate",
                    "offset": "1",
                    "timePeriod": "week"
                  }
                }
              }
            ],
            "lastCalculatedAt": "1358430049",
            "scope": "local",
            "statement": "9208"
          }
        }
      ],
      "lastCalculatedAt": "1358430049"
    } 
    

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"Contact Segment"
    countstring
    elementsList of Segment Element
    lastCalculatedAtstring
    accessedAtintegerDateRequirement
    createdAtintegerReadOnlyDateRequirement
    createdByintegerReadOnlyIdRequirement
    currentStatusstring
    depthRequestDepthEnumRequirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerThe unique identifier for this SegmentIdRequirement
    namestring
    permissionsInstancePermissionEnumRequirement
    scheduledForintegerDateRequirement
    sourceTemplateIdstring
    updatedAtintegerReadOnlyDateRequirement
    updatedByintegerReadOnlyIdRequirement

     

    Related Operations

    • DELETE :  /assets/contact/segment/{id}
    • GET (list) :  /assets/contact/segments?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}

     

    We hope that you find this helpful and please let us know if you have any questions.

     

    Thanks,

    Fred