LogoLogo
  • PAVE OpenAPI Overview
  • How PAVE Works
    • Capture Link
    • Guided Capture
    • Customer Disclosures
    • Identified Vehicle Information
    • Captured Photos
    • Text Notifications
    • Inspection Results
    • Condition Report (PDF)
    • Detected Damages
    • Grading
    • Languages
    • Accuracy & Limitations
  • INTEGRATIONS
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • GET Session Data
        • GET Session Photos
        • GET Session Notes
        • GET Session Results
        • PUT Update Session
        • DELETE Session
      • Webhooks
        • GET All Callbacks
        • GET View a Callback
        • POST Create New Callback
        • PUT Update a Callback
        • DELETE a Callback
      • Deep Linking
        • Deep Link with React Native App
        • Deep Link Native App
        • Deep Linking with Shareable Links
      • Pass-Through Additional User Information
      • Tracking Your Sessions
      • User Session Lifecycle
      • Developer Testing
    • Account Optional Add-ons
      • Capture Only Theme (CAPT)
        • Skip Pictures
      • Right-Hand-Drive Capture Flow
  • MANAGING YOUR ACCOUNT
    • Your Guide to PAVE's Account and Enterprise Dashboards
  • Hotspots
    • PAVE Hotspots API
    • Activating PAVE Hotspots
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • POST Upload Photos
        • GET Results
  • OTHER RESOURCES
    • PAVE Capture Troubleshooting Guide
      • iPhone (iOS) Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Get's Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
      • Android Phone Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Gets Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
    • Policies
      • Service Level Agreement and Standards
      • Service Delivery Sub-Processors & Processors
      • API Strategy and Architecture
      • Information Security Policy
        • Data Quality Guideline
        • Data Retention Policy
        • Backup and Disaster Recovery
        • Data Residency
        • Data Access Control
Powered by GitBook
On this page
  1. INTEGRATIONS
  2. Developer Docs

Tracking Your Sessions

Using Integration Source Types for Tracking Each Session

PAVE's session information includes the source in the results to track each of your launch methods when utilizing PAVE in more than one type of integration in your different types of user journeys. In addition, the source provides three fields to help with your analytics for each of your sessions.

type: indicates what method the session originated from, which can be one of four;

  • api: - This is the source for any session generated using the POST Create Session method using one of your API keys.

  • dashboard: - This is any session that an account user sends when logged into their dashboard.

  • shareable_link: - This is any session generated using your shareable links created in your SETTINGS > WIDGETS.

  • embedded_widget: - This is any session generated from your embedded widgets created in your SETTINGS > WIDGETS.

In properties, you will see api_name: - This is the name you gave the API key when you created it in your DEVELOPER > API KEYS.

  • You will also see dashboard_username if the source type is a dashboard - this is the account username who sent the link.

  • And if the source type is either shareable_link or embedded_widget, you will instead see form_name in the results - this is the name you gave each of these when you created them in your SETTINGS > WIDGETS.

Sample Response with Source Type

"session": {
        "session_key": "TOA-QGMWRCHHGB",
        "theme": "LITE",
        "active": true,
        "status": "IDLE",
        "redirect_url": "https://paveinspect.com/",
        "inspect_started_at": null,
        "inspect_ended_at": null,
        "created_at": "2021-08-17T13:27:10+00:00",
        "updated_at": "2021-08-17T13:27:10+00:00",
        "language": "EN",
        "options": {
            "contact": {
                "first_name": "Luan",
                "last_name": "Tran"
            },
            "reference": {
   "coupon_code": "TST-PAVE-00001",
                "coupon_value": 200
            },
            "sms": {
                "to": "8882298552",
                "to_name": null,
                "from": "8882298552",
                "by": null
            }
        },
        "user_account": {
            "username": "DemoAdmin",
            "first_name": "Demo",
            "last_name": "Admin",
            "email": "someone@discoveryloft.com",
            "phone": null
        },
        "source": {
            "type": "dashboard",
            "properties": {
                "api_name": "TESTOA-12-8",
                "dashboard_username": "DemoAdmin"
            }
        },
        "vehicle": null
    },
PreviousPass-Through Additional User InformationNextUser Session Lifecycle

Last updated 2 years ago