Export API Overview

The Export API provides a way to retrieve large volumes of data from Account Engagement. It uses Account Engagement’s existing API structures, patterns, and terminology.

When to Use the Export API

Use the Export API to retrieve large sets of data when you don’t need synchronous completion responses or when query limitations are too restrictive.

How the Export API Works

An export is associated with a query and a data set in Account Engagement. When you create an export, the query is split into smaller queries, which return smaller sets of data. These smaller queries are processed in parallel, and the retrieved data is saved in CSV files. When the export is complete, the CSV files are available to download.

The order of the records returned in the CSV files isn’t guaranteed. The number of records in each CSV file varies, and all of the files associated with an export make up the full data set for the query.

The Export resource is used to create an export and get the status of an export. When the export is complete, the links to the CSV files containing the data are available in the response.

Export Relationships

A relationship is a property on an object that references another object, denoted in the documentation by the field’s type. For example, Prospects have a relationship field called campaign that links to the Campaign object.

In Version 5 of the Account Engagement API, Export requests can have relationships as part of their fields parameter. Callers of the Export API can use these relationship fields to build exports that retrieve data from multiple objects in a single request, reducing the need for multiple exports. For example, we can create an export for VisitorActivity and include relationship data from Campaigns, Emails, and Prospects.

Limitations

The Export API is subject to the daily Account Engagement API call limit and the concurrent Account Engagement API call limit for your account.
Similar to a queue, Export API calls are executed sequentially for each account. Older exports are processed before newer exports.
The number of fields specified in the Export API calls can’t exceed 150.
Collection fields can’t be exported. For example, on List Email the senderOptions and replyToOptions fields are not supported.
On procedures where no end date is supplied, for example, createdAfter is specified but createdBefore isn’t, the export retrieves all data up until the creation date of the export.
Similar to the Synchronous API, relationships in an Export can have a max depth of 3, for example, on Prospect campaign.folder.parentFolder.name.
Exported relationship fields don’t support any non-scalar value such as related object collections.

Expiration

The data associated with an export expires after 7 days. When data expires, the Export resource removes links to the CSV files and shows that the export has expired. Attempts to retrieve the data after an export expires will fail.

Exports that have not completed processing after 7 days will expire. Expired exports will no longer process and the results will not be made available. To retrieve this data, a new export should be created.

CSV File Formatting

The first row contains the name of the fields.
The remaining rows contain the record data.
Dates are returned in the user’s timezone at the time they created the export.
- For example, if a user is in the “PST” timezone and creates an export, the dates in the export are in “PST”. If a second user is in the “EST” timezone and downloads the exported files, the dates in the export are in “PST”.
- If a user’s timezone changes, previous exports created by the user have dates formatted in the previous timezone. Dates in new exports use the new timezone.
Dates are returned in ISO8601 format: 2023-01-27T09:17:01-05:00. To request the legacy date format, see the legacyDateFormat parameter.
Booleans are represented as true or false in CSV.
Multiselect fields or fields that allow multiple responses return semicolon-delimited values: one;two;three. Semicolons in the field value are escaped with a backslash: first\;value;second\;value.
Fields with null values are represented as empty values in CSV.
Relationship field names in the CSV header are dot delimited.

Getting Started

This document assumes that you’re familiar with connecting to the Account Engagement API, managing objects, and creating CSV files. You can export data by using these endpoints.

Export Endpoints

Verb	URI Path	Action
POST	/v5/exports	Create an export job.
GET	/v5/exports/{id}	Read the status of an export job.
GET	/v5/exports	Query export jobs.
GET	/v5/exports/{id}/results	Download the results for an export job.
POST	/v5/exports/{id}/do/cancel	Cancel an export job.

Fields

Required Editable Fields

These fields are required for the Create operation.

Note

Field	Type	Description
`fields`	Array	Specifies the fields to be exported. Only fields available for query are valid for every object. Fields are required to match the names documented for Version 5 objects. Prospect custom fields require the `__c` suffix. Object relationships can be exported by supplying the dot delimited field notation identical to how Synchronous API relationships are used.
`procedure`	Object	The procedure to execute. A procedure is a query and execution plan used to retrieve data. Each object has its own set of procedures. See the Procedures section for available procedures.

Procedure fields

Field	Type	Description
`name`	String	The name of the object to export and the procedure in the format `Object/Procedure`. The object name is without spaces and isn’t pluralized, e.g. `ListEmail/FilterByCreatedAt`
`arguments`	Object	Arguments used to manipulate the behavior of the procedure. These arguments are specific to the procedure. See the Procedures section for available procedures.

Optional Editable Fields

These are the optional fields for the Create operation.

Note

Field	Type	Description
`includeByteOrderMark`	Boolean	Optional. `False` (Default): Do not include Byte Order Mark header in produced CSV `True`: Include Byte Order Mark header in produced CSV.
`maxFileSizeBytes`	Integer	Optional. (The default value is 209,715,200 bytes, or 200MB). Asks the system to produce files no larger than the provided value. The minimum supported value is 10,000,000 bytes, almost 10MB. The maximum supported value is 209,715,200.
`legacyDateFormat`	Boolean	Optional. `False` (Default): Export CSV contains timestamps in ISO 8601 format: `2023-01-27T09:17:01-05:00`. `True`: Export CSV contains timestamps in legacy format: `2023-01-27 09:17:01`. This format may be easier for legacy CSV readers to interpret.

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of the export job.
`status`	String	The status of the export. See Export State Enum.
`isExpired`	Boolean	Indicates whether the export has expired.
`createdAt`	Datetime	The date and time that the export was created.
`updatedAt`	Datetime	The date and time that the export was last updated.
`createdById`	Integer	ID of the individual who created this export.
`updatedById`	Integer	ID of the individual who last updated this export.
`createdBy`	User	User object representing the user who created this job. See documentation for User for available fields.
`updatedBy`	User	User object representing the user who last updated this job. See documentation for User for available fields.
`resultRefs`	Array	This property contains a list of URLS to CSV files available for download. If there’s no data associated with the export, this property is null. The order of the URLs in the array isn’t significant. The field isn’t available for query.

Create

1POST /api/v5/exports

Used to create an export job.

POST

Params

Field	Description
`fields`	The value for `fields` is a comma-separated enumeration of the fields to be returned. If no fields are input, an error is returned.

Create an Export Job Example Request

Request headers:

1POST /api/v5/exports/?fields=id,createdAt,status,isExpired,updatedAt,includeByteOrderMark,maxFileSizeBytes
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json

Request body:

1{
2    "procedure": {
3        "name": "<ObjectName>/<ProcedureName>",
4        "arguments": {
5            "updatedAfter": "<YYYY-MM-DD>T<HH24:MI:SS-TimezoneOffset>",
6            "updatedBefore": "<YYYY-MM-DD>T<HH24:MI:SS-TimezoneOffset>"
7        }
8    },
9    "fields": [ "<Fields for Object>", ...],
10    "includeByteOrderMark": boolean,
11    "maxFileSizeBytes": int,
12    "legacyDateFormat": boolean
13}

Create an Export Job Example Response

Status Code: 201
Output Representation

1{
2    "id": int,
3    "isExpired": boolean,
4    "createdAt":"<YYYY-MM-DD>T<HH24:MI:SS-TimezoneOffset>",
5    "status": string,
6    "updatedAt":"<YYYY-MM-DD>T<HH24:MI:SS-TimezoneOffset>",
7    "includeByteOrderMark": boolean,
8    "maxFileSizeBytes": int
9}

Errors

Status code: 4xx
Error codes: See Error Codes & Messages

Create a Visitor Activity Export with Relationships Example Request

Request headers:

1POST /api/v5/exports/?fields=id,createdAt,status,isExpired,updatedAt,includeByteOrderMark,maxFileSizeBytes
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json

Request body:

1{
2  "procedure": {
3    "name": "VisitorActivity/FilterByUpdatedAt",
4    "arguments": {
5      "updatedAfter": "2023-05-15T19:04:47-04:00",
6      "updatedBefore": "2024-05-14T00:00:00-04:00",
7      "type": [11],
8      "prospectOnly": false
9    }
10  },
11  "fields": [
12    "id",
13    "campaignId",
14    "campaign.name",
15    "prospectId",
16    "prospect.firstName",
17    "prospect.lastName",
18    "prospect.email",
19    "emailId",
20    "email.name",
21    "email.subject",
22    "type",
23    "typeName"
24  ],
25  "includeByteOrderMark": false,
26  "legacyDateFormat": false,
27  "maxFileSizeBytes": 10000000
28}

Create a Visitor Activity Export with Relationships Example Response

An example VisitorActivity export CSV result that has relationships can be found under the Download Results section.

Status Code: 201
Output Representation

1{
2  "id": 2058,
3  "createdAt": "2024-05-14T11:27:13-04:00",
4  "createdById": 201,
5  "fields": [
6    "id",
7    "campaignId",
8    "campaign.name",
9    "prospectId",
10    "prospect.firstName",
11    "prospect.lastName",
12    "prospect.email",
13    "emailId",
14    "email.name",
15    "email.subject",
16    "type",
17    "typeName"
18  ],
19  "includeByteOrderMark": false,
20  "isExpired": false,
21  "legacyDateFormat": false,
22  "maxFileSizeBytes": 10000000,
23  "procedure": {
24    "arguments": {
25      "prospectOnly": false,
26      "type": [11],
27      "updatedAfter": "2023-05-15T19:04:47-04:00",
28      "updatedBefore": "2024-05-14T00:00:00-04:00"
29    },
30    "name": "VisitorActivity/FilterByUpdatedAt"
31  },
32  "resultRefs": null,
33  "status": "waiting",
34  "updatedAt": "2024-05-14T11:27:13-04:00",
35  "updatedById": 201
36}

Errors

Status code: 4xx
Error codes: See Error Codes & Messages

Read

1GET /api/v5/exports/{id}

Returns the current state of the export.

GET

Params for Read

URL Element	Description
`fields`	(Required) The value for `fields` is a comma-separated enumeration of the fields to be returned.
`id`	(Required) The ID of the export.

Example Request for Read

1GET /api/v5/exports/{id}?fields=id,isExpired,status,resultRefs
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json

Example Response for Read

Status Code: 200

1{
2    "id": int,
3    "status": string,
4    "isExpired": int,
5    "resultRefs": array : ["https://pi.pardot.com/api/v5/exports/{id}/results/{fileId}",...],
6}

Errors for Read

Status code: 4xx
Error codes: See Error Codes & Messages

Query

Retrieving a collection of export jobs follows the conventions described in Version 5 Overview.

Sortable Fields

When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.

id
createdAt
updatedAt

Example Request

1GET /api/v5/exports?fields=id,createdAt,updatedAt,status
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json

Example Response

Status Code: 200

1{
2    "nextPageToken": **null**,
3    "nextPageUrl": **null**,
4    "values": [
5        {
6            "id": int,
7            "createdAt": date,
8            "status": string
9            "updatedAt":date
10        },
11        {
12            "id": int,
13            "createdAt": date,
14            "status": string,
15            "updatedAt":date
16        }
17    ]
18}

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record for it to be returned in the results.

Parameter	Description
`id`	Returns any export where ID is equal to the given integer value.
`idList`	Returns any export where ID is included in the given list of values.
`idGreaterThan`	Returns any export where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any export where ID is greater than or equal to the specified value.
`idLessThan`	Returns any export where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any export where ID is less than or equal to the specified value.
`createdAt`	Returns any export where CreatedAt is equal to the given datetime value.
`createdAtAfter`	Returns any export where CreatedAt is after the given datetime value, non-inclusive.
`createdAtAfterOrEqualTo`	Returns any export where CreatedAt is after or equal to the given datetime value.
`createdAtBefore`	Returns any export where CreatedAt is before the given datetime value, non-inclusive.
`createdAtBeforeOrEqualTo`	Returns any export where CreatedAt is before or equal to the given datetime value.
`updatedAt`	Returns any export where UpdatedAt is equal to the given datetime value.
`updatedAtAfter`	Returns any export where UpdatedAt is after the given datetime value, non-inclusive.
`updatedAtAfterOrEqualTo`	Returns any export where UpdatedAt is after or equal to the given datetime value.
`updatedAtBefore`	Returns any export where UpdatedAt is before the given datetime value, non-inclusive.
`updatedAtBeforeOrEqualTo`	Returns any export where UpdatedAt is before or equal to the given datetime value.
`isExpired`	Determines whether to return expired records. The value can be `false` (default) or `true`

Errors for Query

Status Code: 4xx
Error codes: See Error Codes & Messages

Download Results

1GET /api/v5/exports/{id}/results/{fileId}

The URLs retrieved from the Read endpoint can be used to download the results of the export. A failure occurs when attempting to download any results from an expired export. See Expiration for more information. The URL is provided by the resultRefs field in a read.

GET

Params for Download Results

URL Element	Description
`id`	The ID of the export job.
`fileId`	The ID for the individual export file produced.

Errors for Download Results

Status Code: 4xx
Error codes: See Error Codes & Messages

Example CSV Result with Reltionships

An example CSV file with VisitorActivity Relationships. See Create for the example create request and response for this CSV file.

id	campaignId	campaign.name	prospectId	prospect.firstName	prospect.lastName	prospect.email	emailId	email.name	email.subject	type	typeName
201563	100	”Website Tracking”	616	”Chatty"	"Pardot"	"chatty@salesforce.com”	1056	”Scoring Category Email"	"Scoring Categories”	11	”Email”
201564	302	”Salesforce Buyer’s Guide Campaign”	652	”Astro"	"Nomical"	"astro.nomical@salesforce.com”	1056	”Buyer’s Guide"	"Salesforce Buyer’s Guide”	11	”Email”
…	…	…	…	…	…	…	…	…	…	…	…
992458	302	”Salesforce Buyer’s Guide Campaign”	1502	”Genie"	"Rabbit"	"genie.rabbit@salesforce.com”	2073	”Buyer’s Guide"	"Salesforce Buyer’s Guide”	11	”Email”

Cancel

1POST /api/v5/exports/{id}/do/cancel

Used to cancel the export. If the export is already completed or failed, it can’t be canceled. Canceling an export updates that updatedAt and updatedBy fields of the export.

Cancel Export Example Response

Status Code: 201
Output Representation

1{
2    "id": int,
3    "createdAt": "<YYYY-MM-DD>T<HH24:MI:SS-TimezoneOffset>",
4    "fields": [ string, ...],
5    "includeByteOrderMark": boolean,
6    "isExpired": boolean,
7    "maxFileSizeBytes": int,
8    "procedure": {
9        "arguments": object,
10        "name": string
11    },
12    "status": string,
13    "updatedAt": "<YYYY-MM-DD>T<HH24:MI:SS-TimezoneOffset>"
14}

Errors for Cancel

Status Code: 4xx
Error codes: See Error Codes & Messages

Procedures

Supported Objects
Campaign	Custom Field	Custom Redirect	Dynamic Content
Email Template	External Activity	File	Folder
Form Handler Field	Form Handler	Form	Landing Page
Layout Template	Lifecycle History	Lifecycle Stage Prospect	Lifecycle Stage
List Email	List Membership	List	Opportunity
Prospect Account	Prospect	Tracker Domain	User
Visit	Visitor Activity	Visitor Page View	Visitor

Campaign

See Campaign for more information.

Campaign/FilterByCreatedAt

Retrieves all campaign records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Campaign/FilterByUpdatedAt

Retrieves all campaign records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Custom Field

See Custom Field for more information.

CustomField/FilterByCreatedAt

Retrieves all custom field records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

CustomField/FilterByUpdatedAt

Retrieves all custom fields records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Custom Redirect

See Custom Redirect for more information.

CustomRedirect/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

CustomRedirect/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Dynamic Content

See Dynamic Content for more information.

DynamicContent/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

DynamicContent/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Email Template

See Email Template for more information.

EmailTemplate/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

EmailTemplate/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

External Activity

See External Activity for more information.

ExternalActivity/FilterByActivityDate

Retrieves all visitor activity records with an activityDate value that is greater than the activityAfter argument and less than the activityBefore argument.

Arguments

activityAfter: Selects external activities that occurred after the specified time.. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
activityBefore: Optional. Selects visitor activities that occurred before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

ExternalActivity/FilterByCreatedAt

Retrieves all external activity records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

File

See File for more information.

File/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

File/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Folder

See Folder for more information.

Folder/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Folder/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Form

See Form for more information.

Form/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Form/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Form Handler

See Form Handler for more information.

FormHandler/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

FormHandler/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Form Handler Field

See Form Handler Field for more information.

FormHandlerField/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

Landing Page

See Landing Page for more information.

LandingPage/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

LandingPage/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Layout Template

See Layout Template for more information.

LayoutTemplate/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

LayoutTemplate/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Lifecycle History

See Lifecycle History for more information.

LifecycleHistory/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

Lifecycle Stage

See Lifecycle Stage for more information.

LifecycleStage/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

LifecycleStage/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Lifecycle Stage Prospect

See Lifecycle Stage Prospect for more information.

LifecycleStageProspect/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

List

See List for more information.

List/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

List/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

List Email

See List Email for more information.

ListEmail/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

ListEmail/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

List Membership

See List Membership for more information.

ListMembership/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

ListMembership/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Opportunity

See Opportunity for more information.

Opportunity/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Opportunity/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Prospect

See Prospect for more information.

Prospect/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Prospect/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Prospect Account

See Prospect Account for more information.

ProspectAccount/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Tracker Domain

See Tracker Domain for more information.

TrackerDomain/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

TrackerDomain/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

User

See User for more information.

User/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

User/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Visit

See Visit for more information.

Visit/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

Visit/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

Visitor

See Visitor for more information.

Visitor/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
deleted: (Optional) Selects records based on whether they’re deleted or not. The value can be true, false, or all.

Visitor Activity

See Visitor Activity for more information.

VisitorActivity/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
type: (Optional) Selects visitor activities of the specified types sent as an array of integers. If this argument isn’t specified, then all of the visitor activities belonging to any type is returned. See a list of available Visitor Activity Types in Visitor Activity. Type Session is omitted.
prospectOnly: (Optional) Selects only those visitor activities associated with a prospect. When this field is set to false, all visitor activities with and without a prospect are returned. The values can be true or false.

VisitorActivity/FilterByUpdatedAt

Retrieves all records with an updatedAt value that is greater than the updatedAfter argument and less than the updatedBefore argument.

Arguments

updatedAfter: Selects records that were updated after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
updatedBefore: (Optional) Selects records that were updated before the specified time. This value must be after the value in updatedAfter. If this argument isn’t specified, then all data after the updatedAfter date up until the creation date of the Export is returned. The updatedAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
type: (Optional) Selects visitor activities of the specified types sent as an array of integers. If this argument isn’t specified, then all of the visitor activities belonging to any type are returned. See a list of available Visitor Activity Types in Visitor Activity. Type Session is omitted.
prospectOnly: (Optional) Selects only those visitor activities associated with a prospect. When this field is set to false, all visitor activities with and without a prospect are returned. The values can be true or false.

Visitor Page View

See Visitor Page View for more information.

VisitorPageView/FilterByCreatedAt

Retrieves all records with a createdAt value that is greater than the createdAfter argument and less than the createdBefore argument.

Arguments

createdAfter: Selects records that were created after the specified time. The value must be specified using ISO 8601 formatted date and time (including timezone offset).
createdBefore: (Optional) Selects records that were created before the specified time. This value must be after the value in createdAfter. If this argument isn’t specified, then all data after the createdAfter date up until the creation date of the Export is returned. The createdAfter must be within a year of the creation date of the Export. The value must be specified using ISO 8601 formatted date and time (including timezone offset).

Enums

Export State

waiting: The export is waiting to be processed.
processing: A server has started processing the export.
complete: The export is complete and the results are available for download.
failed: A fatal error has occurred and the data can’t be retrieved. Try executing the export again. If the error occurs again, contact support.
canceled: The export is canceled and can’t be restarted.