Retrieve a list of campaign response export definitions
get
/api/bulk/2.0/campaignResponses/exports
Retrieves a list of campaign response export definitions. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.
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 isterm
ASC | DESC. Example:?orderBy=name ASC
. -
q: string
A URL parameter that specifies query criteria used to filter results. The
q
format isterm
operator
value
. 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 tofalse
, thetotalResults
property will not be returned, and thehasMore
property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default istrue
.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : CampaignResponseExportSearchResponse
Type:
object
Title:
CampaignResponseExportSearchResponse
The response body contains information about the campaign response export definitions.
Show Source
-
count(optional):
integer
Title:
count
Number of results returned in the request. -
hasMore(optional):
boolean
Title:
hasMore
Indicates if there are more results. -
items(optional):
array items
Title:
items
The collection of items returned. -
limit(optional):
integer
Title:
limit
The maximum number of records returned. Set with thelimit
URL parameter, and defaults to 1000 if not specified. -
offset(optional):
integer
Title:
offset
The requested index from which records are returned. Set with theoffset
URL parameter, and defaults to 0 if not specified. -
totalResults(optional):
integer(int64)
Title:
totalResults
Number of total results. Returned when thetotalResults
URL parameter is not set tofalse
.
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
The following examples demonstrate how to retrieve a list of campaign response export definitions using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve a list of campaign response export definitions:
GET /campaignResponses/exports
Content-Type: application/json
Response:
{
"items": [
{
"name": "Example Campaign Response Export",
"fields": {
"CampaignResponseId": "{{CampaignResponse.Id}}",
"MemberStatus": "{{CampaignResponse.Field(MemberStatus)}}",
"CampaignMembershipId": "{{CampaignResponse.Field(IntegrationReturnValue)}}",
"CreatedAt": "{{CampaignResponse.CreatedAt}}",
"CRMCampaignId": "{{CampaignResponse.Campaign.Field(CRMCampaignId)}}",
"EloquaCampaignId": "{{CampaignResponse.Campaign.Id}}",
"EloquaCampaignName": "{{CampaignResponse.Campaign.Field(CampaignName)}}",
"LeadId": "{{CampaignResponse.Contact.Field(C_OracleFusionLeadID)}}",
"ContactId": "{{CampaignResponse.Contact.Field(C_OracleFusionContactID)}}",
"EmailAddress": "{{CampaignResponse.Contact.Field(C_EmailAddress)}}"
},
"filter": "STATUS('{{ActionInstance(7BE704D3AF604775AD416E8D0A5AB212).Execution[12345]}}') = 'pending'",
"syncActions": [
],
"dataRetentionDuration": "PT12H",
"uri": "/campaignResponses/exports/1836",
"createdBy": "API.User",
"createdAt": "2017-11-21T17:20:07.9830000Z",
"updatedBy": "API.User",
"updatedAt": "2017-11-21T17:20:07.9830000Z"
}
],
"totalResults": 1,
"limit": 1000,
"offset": 0,
"count": 1,
"hasMore": false
}
cURL Example
Here is the same example in cURL given an instance with the name APITest
, username API.User
, and POD of 3
.
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/campaignResponses/exports