Query String Parameters in the Search URL
This article provides a guide for customers and CRM integrators who wish to launch Archiver wrapped inside an iframe or as a popup window from a CRM module or other external system.
In this article
Parameter names are case-sensitive. Some parameters work in combination with other parameters and are noted as such below when applicable.
Auth Parameter: token
- Type: Required
- Description: An authentication token, returned after a successful authentication call, as described above. If token parameter is not provided or is invalid, the user will be redirected to the login screen where they can enter their Archiver username and password.
Search Parameter: email
- Type: Required (see Note below)
- Description: The email address to run a search against within Archiver.
- Note: This parameter becomes optional if a custom filterType that does not require email address is used. See examples for a sample use case.
Search Parameters: startDate and endDate
- Type: Optional
- Description: Start and end dates for when the search should be run. If no values are provided the system will default to searching records from the past 30 days. Both fields must be provided if a custom date range is to be run. Dates must be entered in m/d/yyyy format (for example, “1/1/2023”). Leading zeros will be ignored.
Search Parameter: filterSubject
- Type: Optional (see Note below)
- Description: One or more words to be searched in the subject line for messages associated with a specific email address passed in through the searchEmail parameter.
- Note: When the search parameter filterType is used to run a search against custom filters, filterSubject is used to define the search value associated with that filterType, and not to define subject line keywords. In this case, filterSubject is required. See examples for sample use cases.
Search Parameter: filterType
- Type: Optional (see Note below)
- Description: If your Archiver account has been set up with custom filter(s), this parameter can be used to specify which custom filter to search. The URL query string must include:
- filterType=filter-name/X-headername
- filterSubject=filter-value/X-header value (here, filterSubject is used to search for values that correspond to the specified filterType instead of subject line keywords)
- See examples for sample use cases.
- Note: filterType is only supported if:
- Custom filters have been set up in your Archiver account
- Your email campaigns have the filter name and value specified in the email X-header or as HTML comments within the tag of your email(s).