Get list of pages
If no parameter is indicated, will return today's
Query Parameters
- offset integer
The number of items to skip before starting to collect the result set
- limit integer
The number of items to return. If not present, results will be limited to 3000 items
- from_id integer
The visit id from which to start the response dataset
- from_date string
The from date for which to retrieve visit data. Formatted as ISO 8601 without time
- to_date string
The to date for which to retrieve visit data. Formatted as ISO 8601 without time
- 200
- 400
- application/json
- Schema
- Example (from schema)
Schema array
- id integer
The ID of the page
- account string
Account name
- visit_id integer
The ID of the visit
- visitor_id integer
The ID of the visitor
- load_date string
Date the page was loaded. Formatted as ISO 8601 without time
- load_time string
Time the page was loaded. Formatted as ISO 8601 without date
- exit_date string
Date the page was exited. Formatted as ISO 8601 without time
- exit_time string
Time the page was exited. Formatted as ISO 8601 without date
- page_uri string
URI of the page
- page_title string
Title of the page
- page_host_name string
Host name
- page_path string
URI of the page
- last_click_keyword string
Search keyword used to find the website
- last_source string
The location from which the caller originated before making the phone call. Only available on dynamic calls
- last_medium string
The medium from which the caller originated before making the phone call. Only available on dynamic calls
- click_id string
The Google Click ID (gclid), Microsoft Click ID (msclkid) or the Facebook Click ID (fbclid) of the caller. To determine paid ad platform served the click id, use the value of the PaidSearchType field. Only available on paid search dynamic calls
- referring_url string
Referring URL
- ip_address string
IP address of the visitor
- paid_search_type string
Possible values: [
Adwords
,Bing Ads
,Facebook Ads
,N/A
]The type of paid search
- paid_search_match_type string
Possible values: [
broad
,exact
,phrase
]The type of paid search match
- paid_search_ad_group_id integer
Ad group id
- paid_search_ad_group_name string
- paid_search_campaign_id integer
Ad campaign id
- paid_search_campaign_name string
Ad campaign name
- google_client_id string
Google client identifier
- call_id integer[]
user_params object[]
param stringvalue stringfirst_click object[]
visit_id integerkeyword stringsource stringmedium stringtags object[]
tag stringvalue string
[
{
"id": 12,
"account": "Demonstration Client",
"visit_id": 1,
"visitor_id": 2,
"load_date": "2022-10-01",
"load_time": "10:00:00",
"exit_date": "2022-10-01",
"exit_time": "10:00:00",
"page_uri": "https://www.example.com/shop",
"page_title": "Shop",
"page_host_name": "www.example.com",
"page_path": "/shop",
"last_click_keyword": "string",
"last_source": "Facebook",
"last_medium": "social",
"click_id": "CKSDxc_qhLkCFQyk4AodO24Arg",
"referring_url": "https://www.example.com",
"ip_address": "83.693.534.155",
"paid_search_type": "Adwords",
"paid_search_match_type": "broad",
"paid_search_ad_group_id": "1",
"paid_search_ad_group_name": "Care homes",
"paid_search_campaign_id": "2",
"paid_search_campaign_name": "Own Brand",
"google_client_id": "1505735123.1469478123",
"call_id": [
1,
2
],
"user_params": [
{
"param": "string",
"value": "string"
}
],
"first_click": [
{
"visit_id": 0,
"keyword": "string",
"source": "string",
"medium": "string"
}
],
"tags": [
{
"tag": "string",
"value": "string"
}
]
}
]
Validation error in request, details can be found in the body of the response