PlaygroundVisitor Intelligence
Companies with their visits and page views
GET
Retrieves detailed company information and associated visitor session data for a specified domain within a given time range. This is a full export of all sessions combined with all the data. If you want to have single entities please check out the other endpoints.
Description:
This endpoint provides comprehensive data about companies and their visitor sessions for a specified domain. It offers insights into both company details and user engagement metrics, helping you understand not only user behavior but also the companies interacting with your domain.
Authentication:
- To access this endpoint, you need to provide a valid API key.
- The API key is validated using the
get_api_keydependency. - If the API key is missing, invalid, or unauthorized, the endpoint will return an appropriate error response.
Rate Limiting:
- This endpoint is rate-limited to 1 request per second.
- If you exceed the rate limit, you will receive a 429 (Too Many Requests) response.
Parameters:
- domain (required, str): The domain name for which you want to retrieve visitor sessions.
- from_date (optional, str): The starting date and time of the session data range. You can provide an ISO 8601 formatted datetime string or relative dates like '-30 days'. Default is '-30 days'.
- to_date (optional, str): The ending date and time of the session data range. You can provide an ISO 8601 formatted datetime string or 'now' for the current date and time. Default is 'now'.
- page (optional, int): The page number of the results to retrieve. Default is 1.
- page_size (optional, int): The number of entries to retrieve per page, up to a maximum of 10000. Default is 10000.
Notes
- The endpoint uses timezone 'Europe/Berlin' by default.
- The default locale is 'de-DE'.
Returns:
- A JSON object containing the paginated visitor session data based on the specified filters.
For more information and detailed usage instructions, please refer to the API documentation at www.webmetic.de.
APIKeyHeaderheader
Authorization<token>domain*Domainfrom_date?From DateStarting DateTime format or relative dates like '-30 days', '-1 hour', '-5 minutes'. Examples: '2023-01-01', '-7 days', '-12 hours', '-5 minutes', 'now'
Default
"-30 days"to_date?To DateEnding DateTime format or 'now' for the current date/time. Examples: '2023-01-31', 'now'
Default
"now"page?PageSelected result page, starting at 1
Range
1 <= valueDefault
1page_size?Page SizeNumber of entries per page, from 1 up to a maximum of 10000
Range
1 <= value <= 10000Default
10000Companies with their visits and page views; missing fields are absent
application/json- response
pagination*array<>Always one entry
result*array<>Companies with their visits and page views in the date range
Example Request
curl -X GET 'https://hub.webmetic.de/company-sessions?domain=website.example'Example Response
{ "pagination": [ { "total": 1, "page_total": 1, "isFirst": true, "current": 1, "isLast": true, "page_size": 10000 } ], "result": [ { "company_id": "41ea486a9c95", "company_name": "Bergquell Mineralbrunnen GmbH", "company_url": "www.bergquell.example", "company_logo_url": "https://logos.docs.example/bergquell.png", "organization_type": "business", "address": "Brunnenweg 4", "postal_code": "85354", "city": "Freising", "country": "Deutschland", "country_code": "DE", "directors": [ "Florian Obermaier" ], "phone_number": "+49 8161 99998214", "email_address": "info@bergquell.example", "email_pattern": "p1", "employee_count": [ 201, 500 ], "revenue": [ 50000000, 100000000 ], "vat_id": "DE000000000", "registration_number": "HRB 000000", "registration_court": "Amtsgericht München", "primary_color": "#1f6feb", "lead_score": 88, "fit_score": 92, "relevance_score": 80.96, "linkedin": "https://www.linkedin.com/company/bergquell-mineralbrunnen-example", "short_description_de": "Mineralbrunnen mit eigener Abfüllung für Mineralwasser und Erfrischungsgetränke.", "short_description_en": "Mineral spring with its own bottling of mineral water and soft drinks.", "nace_codes": [ { "code": "11.07", "full_code": "C 11.07", "section_code": "C", "section_description_de": "Verarbeitendes Gewerbe/Herstellung von Waren", "section_description_en": "Manufacturing", "division_code": "C11", "division_description_de": "Getränkeherstellung", "division_description_en": "Manufacture of beverages", "description_de": "Herstellung von Erfrischungsgetränken und Mineralwässern", "description_en": "Manufacture of soft drinks and bottled waters" } ], "industry_categories": [ "industrie_fertigung" ], "sessions": [ { "session_id": "01K8B3QW5N7M2XRT4HZJ6C9D0E", "client_id": "3b7e0c55d2a94f18b6c1e0a7d9f42c86e15b0a3d7c9e2f41a8b6d03c5e7f9a12", "timestamp": "2026-10-20T08:20:26.384000", "weburl": "https://nordhafen.example", "utm_source": "google", "utm_medium": "cpc", "utm_campaign": "dampfkessel", "session_duration": 152, "session_time": 76, "session_engagement": 111, "user_agent_browser": { "family": "Chrome", "version": "130.0.0" }, "user_agent_os": { "family": "Windows", "version": "11" }, "user_agent_category": "desktop", "visitor_city": "Freising", "visitor_country": "Deutschland", "visitor_zip": "85354", "visitor_country_code": "DE", "user_data": [ { "timestamp": "2026-10-20T08:20:26.384000", "document_location": "https://nordhafen.example/dampfkessel", "document_title": "Dampfkessel | Nordhafen", "scroll_depth": 75, "referrer": "https://www.google.com/", "time_spent": 64, "engagement_time": 41, "user_events_count": 0 }, { "timestamp": "2026-10-20T08:21:30.384000", "document_location": "https://nordhafen.example/kontakt", "document_title": "Kontakt | Nordhafen", "scroll_depth": 90, "time_spent": 88, "engagement_time": 70, "user_events_count": 1, "events": [ { "type": "form_submit", "target": "kontaktformular", "detail": "https://nordhafen.example/kontakt", "meta": { "fieldCount": 6, "fieldsInteracted": 5, "timeSpent": 64 } } ] } ] } ] } ]}