Lead Forensics Integration Web API - Visits Controller
GetVisitCRM
Input Parameters
- clientuserid (int) - Represents the Client User identifier to be passed to the method.
- businessid (int) - Represents the Business identifier to be passed to the method.
- visitid (Int64) - Represents the Visit identifier to be passed to the method.
Output
- InternalCRMID - Relates to ClientCRMVersionID Unless the client uses the Integration Service.
- CRMID - The CRM identifier
- CRMName - The name of the crm
- CRMLink - The link into the crm for the visit we have posted
- CRMSent - This indicates whether the visit has been sent successfully or not>
Example URL
http://localhost:61028/integrationapi_v1/Visits/GetVisitCRM?clientuserid=61178&businessid=1307949&visitid=387884148
GetClientCRMVersionAutomatic
Input Parameters
- clientid (int)- Represents the Client identifier to be passed to the method.
Output
- VisitXML - The raw XML containing the visit information
- VisitID - The unique Visit identifier
- Assembly - The name of the assembly used
- Class - The class used
- ServiceURL - The service endpoint of the CRM
- User - The user name used for the crm connection
- Password - The password used for the crm connection
- Domain - The domain to connect to at the crm
- Instance - The instance name of the crm to connect to
- InterfaceVersion - he interface version to use with the integration service
- CreateLead - Determines if a lead should be created (0 = no leads created, 1 = create leads)
- ClientID - The Unique Client Identifier
- ClientUserID - The Unique ClientUser Identifier
- ClientCrmVersionID - The Unique ClientCRMVersion Identifier
Example URL
http://localhost:61028/integrationapi_v1/Visits/GetClientCRMVersionAutomatic?clientid=30011
GetCRMSend
Input Parameters
- ClientCrmVersionID (int) - The Unique ClientCRMVersion Identifier
- ClientUserID (int) - The Unique ClientUser Identifier
- DateID (int) - An Identifier for webforensics_client_datemode. Supply 200
- StartDate (datetime) - Date Range Start
- EndDate (datetime) - Date Range End
- Sent (int) - Determies if either Sent visits are shown or unsent visits
- ShowFirst (int) - Filter to Only show the first visit for any business, rather than all visits
- SearchString (string) - Filter on the Business Name
Output
- DateSent - The date that the visit was sent
- BusinessID - The Business identifier
- VisitID - The Visit identifier
- Name - The name of the business
- Referrer - The referrer
- Keywords - The keywords
- PageViews - The number of pages viewed
- Duration - The duration of the visit
- Link - The link to the visit in the client CRM instance
- Image - The url of the CRM image
- CRMID - The CRM identifier
- CRM - The name of the CRM instance
- Sent - Determines if the visit has been successfully sent
Example URL
http://localhost:61028/integrationapi_v1/Visits/GetCRMSend?clientcrmversionid=813&clientuserid=74341&dateid=200&startdate=2015-07-01&enddate=2015-07-09&searchstring=&sent=1&showfirst=0