Contact Logs

Contact logs

The Contact logs resource stores logging information about a Form builder form submission lead by a visitor to a Site.

Contact log Model

Contact log object

A contact log object contains the following fields
Attribute
Type
Description
id
integer
unique id of the log
site_id
integer
Reference id to the Site the lead was associated with
form_id
integer
Reference id to the Form builder form that the lead was associated with
timestamp
datetime
Date and time that the lead was generated
spam
boolean
Was the lead identified as spam by filters.
note
string
If the lead was identified as spam (spam=true), then reason is described here.
data
object
Contains the fields and values of the form lead
email
string
Parsed email address from lead, if applicable
name
string
Parsed name from lead, if applicable
phone
string
Parsed phone number from lead, if applicable
recipients
list
List of intended or delivered recipients (email addresses) for the lead
campaign_params
object
Session analytics attributes. These include thing like UTM parameters and other tracked attributes.

Example object

{
"campaign_params": {
"utm_campaign": "ppc campaign",
"utm_source": "google",
...
},
"data": {
"email-addresss": "[email protected]",
"your-name": "John Doe",
"phone": "206-555-5555",
"subscribe": true
},
"email": "[email protected]",
"form_id": 12345,
"id": 328269,
"ip": "187.232.189.217",
"name": "John Doe",
"note": "Flagged as spam by Akismet",
"phone": "206-555-5555",
"recipients": ["[email protected]", "[email protected]"],
"resource_uri": "/api/v2/contact_log/328269/",
"site_id": 12345,
"spam": true,
"timestamp": "2012-06-01T09:28:46",
...
}
Note: there are a number of columns not listed above that are present in the API response. It is not guaranteed that all leads contain these fields, so integrations should not be developed that depend on them.

List contact logs

List all contact logs within the instance
GET /api/v2/contact_log/
List all contact form logs for a site
GET /api/v2/contact_log/?site_id=12345

Parameters

Name
Type
Description
site_id
string
ID of the Site you want to get the logs for
order_by
string
Set the field to sort the results by. Available order_by includes id (default). You can also sort decending by prefixing the field with a minus sign (i.e. order_by=-id)
id__gt
string
Filter the list to only the contact logs greater than a certain contact log ID

Response

{
"meta": {
"limit": 20,
"next": "/api/v2/contact_log/?limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"email": "[email protected]",
"form_id": 12345,
"id": 328269,
"ip": "187.232.189.217",
"name": "John Doe",
"note": "Flagged as spam by Akismet",
"phone": "206-555-5555",
"resource_uri": "/api/v2/contact_log/328269/",
"site_id": 12345,
"spam": true,
"timestamp": "2012-06-01T09:28:46"
...
},
...
]
}