| Name |
Description |
| after_date |
String
DATETIME. Return only matches dated after this date time. Format “YYYY-MM-DD HH:MM:SS” in GMT
|
| before_date |
String
DATETIME. Return only matches dated before this date time.
|
| first_row |
Integer
(Default value 0). All of the matches are sorted and numbered starting from 0. E.g. if you have 100,000 matches, these are rows 0 through 99,999. If you specify a first_row, then the returned matches will be those rows starting from that row. E.g. without a specification (or if you specify 0), you might get rows 0 through 49,999. In your next request you might specify first_row=50000 to get rows 50000 to 99,999.
|
| from_date |
String
DATETIME. Return only matches dated on or after this date time.
|
| matches |
Integer
(Default value 50000). You can set matches to any value from 0 to 50000. This sets the maximum number of matches that will be returned in response to your request. Note that if the response size starts to exceed 50MB, then the response can still include fewer than your “matches” number, to keep the response size reasonable. If you specify “0” here, then no matches will be returned; however, you will still get the information on the number of matches that there were. For asynchronous reports (ones where a destination is specified), the matches parameter is not limited to 50000, but it still defaults to 50000 if not specified. If you expect a larger number of rows, then you must explicitly approve the maximum size of the result set by setting matches appropriately. This helps prevent accidental queries that produce very larger result sets.
|
| through_date |
String
DATETIME. Return only matches dated before or on this date time.
|
| destination |
String
For reporting requests. Specifying a destination makes the report "asynchronous." This means that a background job will be created to run the report and upload the final CSV file to the requested destination. The API request to start the report will return immediately with a background "job number" and the filename that will be uploaded. The supported value of "destination" is currently only "sftp" for a Secure FTP upload over SSH (as opposed to ftps, which would be a Secure FTP upload over SSL). When "destination" is specified, additional destination parameters are also required. Note that for SFTP uploads, there is a 15-minute upload timeout -- uploads that take longer (e.g., due to slow SFTP servers) will be aborted. WARNING: Multiple concurrent large asynchronous report requests will impact your database performance: reports will take longer to generate and your LuxSci services will experience degraded/slower performance.
|
| destination_directory |
String
For asynchronous reporting requests. This optional parameter will be the subdirectory to change to on the SFTP server before uploading the report CSV file. Technically speaking, this will be the argument provided to the SFTP "chdir" command.
|
| destination_hostname |
String
For asynchronous reporting requests. This will be the hostname of the SFTP server to which the report CSV file should be uploaded.
|
| destination_password |
String
For asynchronous reporting requests. This will be the password to be used for the login to the SFTP server to which the report CSV file should be uploaded.
|
| destination_username |
String
For asynchronous reporting requests. This will be the username to be used for the login to the SFTP server to which the report CSV file should be uploaded.
|
| clicked |
Integer
Integer. If specified, the results are restricted as follows:
clicked < 0 – select messages where URL click tracking was not enabled.
clicked = 0 – select messages where URL click tracking was enabled, but where there have as yet been no clicks on any clinks in the messages.
clicked > 0 – select messages where URL click tracking was enabled and where there have been N or more clicks on links in the same message to the same recipient. N, in this case, is the number that you have specified as the value of the “clicked” parameter. I.e., using a value of “1” matches all messages that have had a link clicked on.
|
| from |
String
String. Case-insensitive substring search of the message “From” email Address
|
| ip |
String
String. Case-insensitive substring search of the sender IP address (for SMTP reports only).
|
| header1 |
|
| header1_operator |
|
| header1_value |
|
| header2 |
|
| header2_operator |
|
| header2_value |
|
| header3 |
|
| header3_operator |
|
| header3_value |
|
| opened |
Integer
Integer. If specified, the results are restricted as follows:
opened < 0 – select messages where open tracking was not enabled.
opened = 0 – select messages where open tracking was enabled, but which have not yet been opened.
opened > 0 – select messages where open tracking was enabled and which have been opened at least N times. N, in this case, is the number that you have specified as the value of the “opened” parameter. I.e., using a value of “1” matches all messages that have been opened.
|
| secureline |
String
Enum. Value:
u – Message to this recipient did not use SecureLine (or Opt Out was used)
e – Message did use SecureLine
-2 – SecureLine was not used due to Opt Out being selected
-1 – SecureLine usage not recorded for some reason
1 – SecureLine:PGP was used
2 – SecureLine:S/MIME was used
3 – SecureLine:Escrow was used
4 – SecureLine:TLS was used
|
| sendmail_id |
String
String. Return only the messages with the specified sendmail_id
|
| sendmail_ids |
String
Comma-delimited list of up to 100 sendmail ids. Returns any matching messages.
|
| sent_date |
Integer
If set to true (i.e., 1), the email message sent date will be used for date/time selections, instead of the date of the last update of the row.
|
| state |
String
Optionally, match only messages with specific delivery states. This is a comma-delimited list of one or more states to match. The possible states include:
delivered - Successful delivery.
perm_fail - Message immediately rejected by recipient servers.
ba_hard_fail - Post-delivery hard bounce.
ba_soft_fail - Post-delivery soft bounce.
temp_fail - Message still queued after 1+ temporary delivery failures.
queued - Message queued -- includes the "temp_fail" state.
lost - Message delivery status unknown.
any_hard_fail - "perm_fail" or "ba_hard_fail".
failed - "perm_fail" or "ba_hard_fail" or "ba_soft_fail".
not_queued - "delivered" or "lost" or any of the "failed" states.
|
| state_detail |
String
Optionally, match only messages where the "state_detail" delivery status description contains the specified text (case insensitive).
|
| delivery_date |
Integer
If set to true (i.e., 1), the email message last delivery status updated date will be used for date/time selections, instead of the date of the last update of the row.
|
| spam |
Integer
Enum. Value:
0 – Message was not marked as spam by a recipient and returned in a Feed Back Loop.
1 – Message was marked as spam by a recipient and returned in a Feed Back Loop
|
| unsubscribed |
Integer
Enum. Value: 0 – The recipient did not unsubscribe based on this email message. 1 – The recipient did unsubscribe based on this email message.
|
| smtp_code |
String
String. 1-3 characters. Substring match to the beginning of the smtp_code field. E.g., 5 matches all codes starting with 5.
|
| tls |
Integer
Enum. Value:
0 – TLS was NOT used in the successful delivery of this message to the recipient server
1 – TLS was used in the successful delivery of this message to the recipient server.
|
| tracked_headers |
|
| template_id |
Integer
Optional template ID to select results only for those messages sent using the specified template. A value of 0 selects all.
|
| to |
String
Case-insensitive substring search of all recipient email addresses.
|
| user_id |
Integer
Integer. Restrict the report to the user with this specific User ID number
|
