Retrieve all spam form submit jobs for a single form
get
/api/rest/2.0/data/form/{formId}/formSpamData
Retrieves all spam form submissions for a form specified by the
formId
. This API endpoint is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.Request
Supported Media Types
- application/json
Path Parameters
-
formId(required): string
ID of the form.
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
page: integer
Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
-
startAt: integer
The earliest date time for which the request will retrieve data, expressed in Unix time.
Response
Supported Media Types
- application/json
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.
Examples
The following examples demonstrate how to retrieve spam form submissions using an HTTP request and cURL. For more information on requests, see API requests.
HTTP request examples
Retrieve all spam form submissions for the form with ID 3:
GET /api/REST/2.0/data/form/3/formSpamData
Content-Type: application/json
Response:
{
"elements": [
{
"type": "FormSpamData",
"id": "1223",
"blockReason": "invalidtoken",
"fieldValues": [
{
"type": "FieldValue",
"name": "elqFormName",
"value": "UntitledForm-1609416910232"
},
{
"type": "FieldValue",
"name": "elqSiteId",
"value": "12345"
},
{
"type": "FieldValue",
"name": "elqFormSubmissionToken",
"value": "h0icHRkXyVs8CnaO8h2BHfBESgGMJeZdSLntLnqxCP3ofOLGLs5RGRyUEoOuu_rLwyRY1QpBC6gJM6tEHRg3olKXLMWixUjf52SaE.9qlRHe7PppOXrKtgDnz2Ug"
},
{
"type": "FieldValue",
"name": "elqCampaignId",
"value": "1234"
},
{
"type": "FieldValue",
"name": "firstName",
"value": "John"
},
{
"type": "FieldValue",
"name": "lastName",
"value": "Smith"
},
{
"type": "FieldValue",
"name": "emailAddress",
"value": "john.smith@oracle.com"
},
{
"type": "FieldValue",
"name": "address1",
"value": ""
},
{
"type": "FieldValue",
"name": "LP",
"value": "4905"
}
],
"formSubmissionSource": "post",
"submittedAt": "1609419578"
}
],
"page": 1,
"pageSize": 1000,
"total": 1
}
Retrieve spam form submissions where the form submissions were blocked because of an authentication mismatch issue:
GET /api/REST/2.0/data/form/3/formSpamData?search=blockreason=authhashmismatch
Content-Type: application/json
Response:
{
"elements": [
{
"type": "FormSpamData",
"id": "1236",
"blockReason": "authhashmismatch",
"fieldValues": [
{
"type": "FieldValue",
"name": "firstName",
"value": "John"
},
{
"type": "FieldValue",
"name": "lastName",
"value": "Smith"
},
{
"type": "FieldValue",
"name": "emailAddress",
"value": "john.smith@oracle.com"
},
{
"type": "FieldValue",
"name": "elqFormName",
"value": "UntitledForm-1536934056562"
},
{
"type": "FieldValue",
"name": "elqSiteId",
"value": "426809016"
}
],
"formSubmissionSource": "get",
"submittedAt": "1610023989"
},
{
"type": "FormSpamData",
"id": "1235",
"blockReason": "authhashmismatch",
"fieldValues": [
{
"type": "FieldValue",
"name": "firstName",
"value": "John"
},
{
"type": "FieldValue",
"name": "lastName",
"value": "Smith"
},
{
"type": "FieldValue",
"name": "emailAddress",
"value": "john.smith@oracle.com"
},
{
"type": "FieldValue",
"name": "elqFormName",
"value": "UntitledForm-1536934056562"
},
{
"type": "FieldValue",
"name": "elqSiteId",
"value": "426809016"
}
],
"formSubmissionSource": "get",
"submittedAt": "1610022883"
}
],
"page": 1,
"pageSize": 1000,
"total": 2
}
Retrieve all spam form submissions for the form with ID #3, since January 1st, 2021:
GET /api/REST/2.0/data/form/3/formSpamData?startAt=1609462800
Content-Type: application/json
Response:
{
"elements": [
{
"type": "FormSpamData",
"id": "1236",
"blockReason": "authhashmismatch",
"fieldValues": [
{
"type": "FieldValue",
"name": "firstName",
"value": "John"
},
{
"type": "FieldValue",
"name": "lastName",
"value": "Smith"
},
{
"type": "FieldValue",
"name": "emailAddress",
"value": "john.smith@oracle.com"
},
{
"type": "FieldValue",
"name": "elqFormName",
"value": "UntitledForm-1536934056562"
},
{
"type": "FieldValue",
"name": "elqSiteId",
"value": "426809016"
}
],
"formSubmissionSource": "get",
"submittedAt": "1610023989"
},
...
],
"page": 1,
"pageSize": 1000,
"total": 5
}
cURL example
Here is the first 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/REST/2.0/data/form/3/formSpamData