Visit Object
Use visit resources to learn about a user visit to your website. Discover the user's Account Engagement ID, Google Analytics parameters, and other information.
Include the authentication header with every request. For information on how to authenticate, see Authentication.
| Resource Name | Operation | Description |
|---|---|---|
| Visit Query | GET | Request information for visit records that matches the specified criteria. |
| Visit Read | GET | Request information for a single visit record. |
Request information for the visit records that match the specified criteria. You can specify the visit records and fields to request. A maximum of 200 records are returned. To return all visit records, specify the output as mobile.
Replace <selection parameter> with ids, visitor_ids, or prospect_ids. Your visit query request must include one selection parameter.
Use these parameters to specify the visit records to return.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
<ids> | array | Account Engagement visit IDs | Requests visit records with the specified Account Engagement visit ID. Separate the IDs with a comma (no spaces). We recommend using a POST request. |
<visitor_ids> | array | Account Engagement visitor IDs | Request visit records with the specified Account Engagement visitor IDs. Separate the IDs with a comma (no spaces). We recommend using a POST request. |
<prospect_ids> | array | Account Engagement prospect IDs | Request visit records with the specified Account Engagement prospect IDs. Separate the IDs with a comma (no spaces). We recommend using a POST request. |
Use these parameters to specify the visit fields to return.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
limit | integer | Any integer from 1 through 200. | The number of visit records to return. Default value is 200. |
offset | integer | Any positive integer | The number of visit records to omit from the response (the number to "skip over"). Remember to include one of the parameters ids, visitor_ids, or prospect_ids. Example: Retrieve a list of visits for the prospect with Account Engagement ID 1234. Sort the visits by Account Engagement ID, and skip over the first 10 visits: /api/visit/version/4/do/query?offset=10&sort_by=ids&prospect_ids=1234. |
Visits are returned in order of ascending ID.
Request information for a single visit record.
Replace <ID> with the Account Engagement ID of the visit record.
Request information about the visit record with ID 1234.
The XML response for a query request contains information for multiple visit records. The XML response for a read request contains information for a single visit record.
| Tag | Description |
|---|---|
<result> | Parent tag. Contains information about the visit records that match the parameters specified in your query. |
<total_results> | Contains the number of visit records selected by the query. Note The query request returns a maximum of 200 visit records. If your query matches more than 200 records, you can make several requests to retrieve all matching records. |
<visit> | Contains information about a single visit record. See Visit in Object Field References for a complete description of fields. |
| Tag | Description |
|---|---|
<visit> | The information about a single visit. See Visit in Object Field References for a complete description of fields. |