SalesViewer© API

Schema file

grab your copy of the JSON Schema here

Schema viewer

{ }objectarraystringintegernumberboolnull"title":SalesViewerDefinitionsobjectarraystringintegernumberboolnullPaginatedResultobjectarraystringintegernumberboolnulldescriptionrespresents a generic but paginated result"title":PaginatedResultpropertiesobjectarraystringintegernumberboolnullpaginationobjectarraystringintegernumberboolnull$ref#\/definitions\/ResultPaginationErrorResponseobjectarraystringintegernumberboolnulldescriptiongeneric error response structure"title":ErrorResponsepropertiesobjectarraystringintegernumberboolnullerrorobjectarraystringintegernumberboolnulldescriptionIndicated that it' an errorerrorDescriptionobjectarraystringintegernumberboolnulldescriptionError descriptionerrorTypeobjectarraystringintegernumberboolnulldescriptionError typeResultPaginationobjectarraystringintegernumberboolnulldescriptionsome metadata for inforamtion about paginated result"title":ResultPaginationpropertiesobjectarraystringintegernumberboolnulltotalobjectarraystringintegernumberboolnulldescriptionNumber of total entriesformatint64isFirstobjectarraystringintegernumberboolnulldescriptionCurrent page is first pagecurrentobjectarraystringintegernumberboolnulldescriptionCurrent page number (1-based)formatint64isLastobjectarraystringintegernumberboolnulldescriptionCurrent page is last pagepageSizeobjectarraystringintegernumberboolnulldescriptionSize (=number of entries) of each pageformatint64GetSessionsResponseobjectarraystringintegernumberboolnulldescriptionresponse structure of any `\/session.json` query"title":GetSessionsResponsepropertiesobjectarraystringintegernumberboolnulltotalsobjectarraystringintegernumberboolnull$ref#\/definitions\/GetSessionsResultTotalsresultobjectarraystringintegernumberboolnulldescriptionArray of `SessionPublic` (query results)itemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionPublicAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/PaginatedResultGetSessionsResultTotalsobjectarraystringintegernumberboolnulldescriptionsome metadata information of object counts"title":GetSessionsResultTotalspropertiesobjectarraystringintegernumberboolnullsessionsobjectarraystringintegernumberboolnulldescriptionTotal number of unique sessionsformatint64companiesobjectarraystringintegernumberboolnulldescriptionTotal number of unique companiesformatint64visitsobjectarraystringintegernumberboolnulldescriptionTotal number of page visitsformatint64interest_visitsobjectarraystringintegernumberboolnulldescriptionTotal number of page visits which triggered interestformatint64interestsobjectarraystringintegernumberboolnulldescriptionTotal number of interests triggeredformatint64UrlobjectarraystringintegernumberboolnulldescriptionURL object (can be implicitly casted to string)"title":Urlpropertiesobjectarraystringintegernumberboolnullschemeobjectarraystringintegernumberboolnulldescriptionprotocol scheme (e.g. `http` or `https`)hostobjectarraystringintegernumberboolnulldescriptionhostname (e.g. `salesviewer.com`) _Note: `www.salesviwer.com` is an other host than `salesviewer.com`, maybe use `like(host, '%salesviwer.com')`_\nformathostnamepathQueryFragmentobjectarraystringintegernumberboolnulldescriptionpath, query and fragment of URL, e.g. `\/api\/?query=test#result`\npathQueryobjectarraystringintegernumberboolnulldescriptionpath and query of URL, e.g. `\/api\/?query=test`\npathobjectarraystringintegernumberboolnulldescriptionpath of URL, e.g. `\/api\/`\nqueryFragmentobjectarraystringintegernumberboolnulldescriptionquery and fragment of URL, e.g. `query=test#result`\nqueryobjectarraystringintegernumberboolnulldescriptionquery of URL, e.g. `query=test&foo=baz&utm_source=test&utm_media=online`\nfragmentobjectarraystringintegernumberboolnulldescriptionquery and fragment of URL, e.g. `result`\nSessionobjectarraystringintegernumberboolnulldescriptioncommon session object"title":SessionpropertiesobjectarraystringintegernumberboolnullguidobjectarraystringintegernumberboolnulldescriptionUUID of SessionstartedAtobjectarraystringintegernumberboolnulldescriptionSession started at (in given timezone)formatdate-timelastActivityAtobjectarraystringintegernumberboolnulldescriptionSession last activity at (in given timezone)formatdate-timedurationobjectarraystringintegernumberboolnulldescriptionDuration of session in TIME format (Rfc3339 time components)formatdate-timelanguageobjectarraystringintegernumberboolnulldescriptionSession language\/localecompanyobjectarraystringintegernumberboolnull$ref#\/definitions\/CompanyPublicvisitsobjectarraystringintegernumberboolnulldescriptionSession visits of this session. \nNOTE: if `includeVisits`-parameter set to `false`, result won't contain visits field.\nitemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionVisitinterestsobjectarraystringintegernumberboolnulldescriptioninterests triggered by one or more visits in this session\nitemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionInterestSessionQueryobjectarraystringintegernumberboolnulldescriptionqueryable session object"title":Sessionpropertiesobjectarraystringintegernumberboolnulldateobjectarraystringintegernumberboolnulldescriptionalias of `started_at`formatdate-timelocaleobjectarraystringintegernumberboolnulldescriptionalias of `language`userAgentobjectarraystringintegernumberboolnulldescriptionclients user agent stringcompanyobjectarraystringintegernumberboolnull$ref#\/definitions\/CompanyQueryvisitsobjectarraystringintegernumberboolnulldescriptionSession visits of this session. \nNOTE: if `includeVisits`-parameter set to `false`, result won't contain visits field.\nitemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionVisitQueryinterestsobjectarraystringintegernumberboolnulldescriptioninterests triggered by one or more visits in this session\nitemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionInterestQueryAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/SessionSessionPublicobjectarraystringintegernumberboolnulldescriptionpublic session object"title":SessionpropertiesobjectarraystringintegernumberboolnullstartedAt_ts_serverobjectarraystringintegernumberboolnulldescriptionSession started at UNIX-Timeformatdate-timelastActivityAt_ts_serverobjectarraystringintegernumberboolnulldescriptionSession last activity at UNIX-Timeformatdate-timeduration_secsobjectarraystringintegernumberboolnulldescriptionDuration of session in secondsformatint64companyobjectarraystringintegernumberboolnull$ref#\/definitions\/CompanyPublicvisitsobjectarraystringintegernumberboolnulldescriptionSession visits of this session. \nNOTE: if `includeVisits`-parameter set to `false`, result won't contain visits field.\nitemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionVisitPublicinterestsobjectarraystringintegernumberboolnulldescriptioninterests triggered by one or more visits in this session\nitemsobjectarraystringintegernumberboolnull$ref#\/definitions\/SessionInterestPublicCompanyobjectarraystringintegernumberboolnulldescriptioncommon company object"title":CompanypropertiesobjectarraystringintegernumberboolnullidobjectarraystringintegernumberboolnulldescriptionID of companystreetobjectarraystringintegernumberboolnulldescriptionStreet of companyzipobjectarraystringintegernumberboolnulldescriptionZip of companynameobjectarraystringintegernumberboolnulldescriptionName of companyphoneobjectarraystringintegernumberboolnulldescriptionPhone of companyemailobjectarraystringintegernumberboolnulldescriptionE-Mail address of companycityobjectarraystringintegernumberboolnulldescriptionCity of companylatitudeobjectarraystringintegernumberboolnulldescriptionGeographical latitude of company's addressformatdoublelongitudeobjectarraystringintegernumberboolnulldescriptionGeographical longitude of company's addressformatdoubleurlobjectarraystringintegernumberboolnulldescriptionURL of company's websitecountyCodeobjectarraystringintegernumberboolnulldescriptionCountry code in (ISO 3166 Alpha 2) format (e.g. `DE`)countyCode3objectarraystringintegernumberboolnulldescriptionCountry code in (ISO 3166 Alpha 3) format (e.g. `DEU`)isCustomerobjectarraystringintegernumberboolnulldescriptionIndicates if company is marked as customerisFavoriteobjectarraystringintegernumberboolnulldescriptionIndicates if company is marked as favoriteisCompetitorobjectarraystringintegernumberboolnulldescriptionIndicates if company is marked as competitorsectorobjectarraystringintegernumberboolnull$ref#\/definitions\/CompanySectorCompanyQueryobjectarraystringintegernumberboolnulldescriptionqueryable company object"title":CompanyQuerypropertiesobjectarraystringintegernumberboolnullwebsiteobjectarraystringintegernumberboolnull$ref#\/definitions\/Urlurlobjectarraystringintegernumberboolnull$ref#\/definitions\/Urlsectorobjectarraystringintegernumberboolnull$ref#\/definitions\/CompanySectorQueryAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/CompanyCompanyPublicobjectarraystringintegernumberboolnulldescriptionpublic company object"title":CompanyPublicpropertiesobjectarraystringintegernumberboolnullsectorobjectarraystringintegernumberboolnull$ref#\/definitions\/CompanySectorPublicAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/CompanyCompanySectorobjectarraystringintegernumberboolnulldescriptioncommon company sector object"title":CompanySectorpropertiesobjectarraystringintegernumberboolnullidobjectarraystringintegernumberboolnulldescriptionID of sectorformatint64nameobjectarraystringintegernumberboolnulldescriptionName of sectorCompanySectorQueryobjectarraystringintegernumberboolnulldescriptionqueryable company sector object"title":CompanySectorQueryAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/CompanySectorCompanySectorPublicobjectarraystringintegernumberboolnulldescriptionpublic company sector object"title":CompanySectorPublicAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/CompanySectorSessionVisitobjectarraystringintegernumberboolnulldescriptioncommon session visit object"title":SessionVisitpropertiesobjectarraystringintegernumberboolnullidobjectarraystringintegernumberboolnulldescriptionID of Session visitformatint64startedAtobjectarraystringintegernumberboolnulldescriptionSession visit started at (in given timezone)formatdate-timelastActivityAtobjectarraystringintegernumberboolnulldescriptionSession visit last activity at (in given timezone)formatdate-timedurationobjectarraystringintegernumberboolnulldescriptionDuration of session visit in TIME format (Rfc3339 time components)formatdate-timeduration_secsobjectarraystringintegernumberboolnulldescriptionDuration of session visit in secondsformatprecisionurlobjectarraystringintegernumberboolnulldescriptionURL of the session visitnumEventsobjectarraystringintegernumberboolnulldescriptionNumber of events collected during website sessionformatint64refererobjectarraystringintegernumberboolnulldescriptionReferer URL of the session visitrefererSourceobjectarraystringintegernumberboolnulldescriptionReferer parsed `source`-componentrefererTermobjectarraystringintegernumberboolnulldescriptionReferer parsed `term`-componentrefererMediumobjectarraystringintegernumberboolnulldescriptionReferer parsed `medium`-componentSessionVisitQueryobjectarraystringintegernumberboolnulldescriptionqueryable session visit object"title":SessionVisitQuerypropertiesobjectarraystringintegernumberboolnullurlobjectarraystringintegernumberboolnull$ref#\/definitions\/Urlrefererobjectarraystringintegernumberboolnull$ref#\/definitions\/UrlAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/SessionVisitSessionVisitPublicobjectarraystringintegernumberboolnulldescriptionpublic session visit object"title":SessionVisitPublicpropertiesobjectarraystringintegernumberboolnullstartedAt_ts_serverobjectarraystringintegernumberboolnulldescriptionSession visit started at UNIX-Timeformatdate-timelastActivityAt_ts_serverobjectarraystringintegernumberboolnulldescriptionSession visit last activity at UNIX-Timeformatdate-timeAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/SessionVisitSessionInterestobjectarraystringintegernumberboolnulldescriptioncommon session interest object"title":SessionInterestpropertiesobjectarraystringintegernumberboolnullidobjectarraystringintegernumberboolnulldescriptionID of interestformatint64nameobjectarraystringintegernumberboolnulldescriptionname of interestSessionInterestQueryobjectarraystringintegernumberboolnulldescriptionquerably session interest object"title":SessionInterestQueryAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/SessionInterestSessionInterestPublicobjectarraystringintegernumberboolnulldescriptionquerably session interest object"title":SessionInterestPublicAllOf{ }objectarraystringintegernumberboolnull$ref#\/definitions\/SessionInterest