Jump to

• Request
• Response

Retrieve a list of activities.

get

/api/rest/2.0/data/activities/contact/{id}/{type}

Retrieves a list of contact activities specified by id and type parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Id of the contact whose activity to retrieve.
• type(required): string
  Type of the activity to retrieve.

Query Parameters

• count: string
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• 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 minimal by default.
• endAt: string
  The end date time for which the request will retrieve data, expressed in Unix time.
• startAt: string
  The earliest date time for which the request will retrieve data, expressed in Unix time.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultActivity

Type: object

Title: QueryResultActivity

Show Source

• elements: array elements
  Array of Activity fields.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultActivity",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of Activity fields.",
            "items":{
                "$ref":"#/definitions/ActivityRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of Activity fields.

Show Source

• Array of: object Activity
  Title: Activity

{
    "type":"array",
    "description":"Array of Activity fields.",
    "items":{
        "$ref":"#/definitions/ActivityRest20"
    }
}

Nested Schema : Activity

Type: object

Title: Activity

Show Source

• assetId: string
  The ID of the asset associated with the activity
• assetName: string
  The name of the asset associated with the activity
• assetType: string
  The type of asset associated with the activity, such as email and form
• contactId: string
  The ID of the contact who performed the activity
• createdAt: string
  Read Only: true

  The date and time of the activity
• fieldValues: array fieldValues
  Array containing the details of the activity.
• id: string
  The unique identifier of the activity per activity type, except for EmailSend
• type: string
  The type of activity.

{
    "title":"Activity",
    "properties":{
        "type":{
            "type":"string",
            "description":"The type of activity."
        },
        "id":{
            "type":"string",
            "description":"The unique identifier of the activity per activity type, except for EmailSend"
        },
        "contactId":{
            "type":"string",
            "description":"The ID of the contact who performed the activity"
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time of the activity"
        },
        "assetId":{
            "type":"string",
            "description":"The ID of the asset associated with the activity"
        },
        "assetName":{
            "type":"string",
            "description":"The name of the asset associated with the activity"
        },
        "assetType":{
            "type":"string",
            "description":"The type of asset associated with the activity, such as email and form"
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing the details of the activity.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : fieldValues

Type: array

Array containing the details of the activity.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Array containing the details of the activity.",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "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