REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a list of contact filters

get

/api/bulk/2.0/contacts/filters

Retrieves a list of contact filters that match the criteria specified in the URL parameters.

Request

Supported Media Types

application/json
text/csv

Query Parameters

limit: integer

A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.
links: string

The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
offset: integer

Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.
orderBy: string

Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.
q: string

A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".
totalResults: boolean

Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : ContactFilterSearchResponse

Type: object

Title: ContactFilterSearchResponse

The response body contains information about the contact export definitions.

Show Source

count: integer

Title: count

Number of results returned in the request.
hasMore: boolean

Title: hasMore

Indicates if there are more results.
items: array items

Title: items

The collection of items that match the search.
limit: integer

Title: limit

The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.
offset: integer

Title: offset

The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.
totalResults: integer(int64)

Title: totalResults

Number of total results. Returned when the totalResults URL parameter is not set to false.

{
    "title":"ContactFilterSearchResponse",
    "description":"The response body contains information about the contact export definitions.",
    "properties":{
        "count":{
            "title":"count",
            "description":"Number of results returned in the request.",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"Indicates if there are more results.",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"The collection of items that match the search.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContactFilter"
            }
        },
        "limit":{
            "title":"limit",
            "description":"The maximum number of records returned. Set with the <code>limit</code> URL parameter, and defaults to 1000 if not specified.",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"The requested index from which records are returned. Set with the <code>offset</code> URL parameter, and defaults to 0 if not specified.",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"Number of total results. Returned when the <code>totalResults</code> URL parameter is not set to <code>false</code>.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

The collection of items that match the search.

Show Source

Array of: object ContactFilter

Title: ContactFilter

The definition of a dynamic list of contacts in Eloqua, for global use.

{
    "title":"items",
    "description":"The collection of items that match the search.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContactFilter"
    }
}

Nested Schema : ContactFilter

Type: object

Title: ContactFilter

The definition of a dynamic list of contacts in Eloqua, for global use.

Show Source

count: integer

Title: count

The number of items returned. In items: the number of records operated on for that message.
createdAt: string(date-time)

Title: createdAt

The date and time the contact filter was created, expressed using the ISO-8601 standard. This is a read-only property.
createdBy: string

Title: createdBy

The login id of the user who created the contact filter field. This is a read-only property.
executedAt: string(date-time)

Title: executedAt

The time and date the contact filter was last used.
name: string

Title: name

The name of the contact definition.
statement: string

Title: statement

The markup language statement used to reference the field in an import or export mapping.
updatedAt: string(date-time)

Title: updatedAt

The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
updatedBy: string

Title: updatedBy

The login id of the user that last updated the entity. This is a read-only property.
uri: string

Title: uri

System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"ContactFilter",
    "description":"The definition of a dynamic list of contacts in Eloqua, for global use.",
    "properties":{
        "count":{
            "title":"count",
            "description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
            "type":"integer"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the contact filter was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the contact filter field. This is a read-only property.",
            "type":"string"
        },
        "executedAt":{
            "format":"date-time",
            "title":"executedAt",
            "description":"The time and date the contact filter was last used.",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The name of the contact definition.",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"The markup language statement used to reference the field in an import or export mapping.",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "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 contact filters with "Touch" somewhere in the name field:


GET /contacts/filters?q="name=*Touch*"

Response:


{
    "items":[
        {
            "name":"Lead Score - Last High Touch Event - Last 180 Days",
            "count":0,
            "statement":"{{ContactFilter[100050]}}",
            "uri":"/contacts/filters/100050",
            "createdBy":"Deploy.User",
            "createdAt":"2010-02-24T18:40:36.1230000Z",
            "updatedBy":"Deploy.User",
            "updatedAt":"2010-02-24T18:40:36.1230000Z"
        },
        {
            "name":"Lead Score - Last High Touch Event - Last 30 Days",
            "count":0,
            "statement":"{{ContactFilter[100051]}}",
            "uri":"/contacts/filters/100051",
            "createdBy":"Deploy.User",
            "createdAt":"2010-02-24T18:41:07.0200000Z",
            "updatedBy":"Deploy.User",
            "updatedAt":"2010-02-24T18:41:07.0200000Z"
        },
        {
            "name":"Lead Score - Last High Touch Event - Last 60 Days",
            "count":0,
            "statement":"{{ContactFilter[100052]}}",
            "uri":"/contacts/filters/100052",
            "createdBy":"Deploy.User",
            "createdAt":"2010-02-24T18:41:30.9070000Z",
            "updatedBy":"Deploy.User",
            "updatedAt":"2010-12-22T00:21:40.3970000Z"
        }
    ],
    "totalResults":3,
    "limit":1000,
    "offset":0,
    "count":3,
    "hasMore":false
}