Skip to main content
Get Analytics Data

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

OK

Carrier object for AnalyticsData. Services for the AnalyticsData Carrier is available from the Diagnostics Agent.

Name
string

User full name. Only included in Sod

Email
string

User email address. Only included in Sod

Company
string

User company name. Only included in Sod

LicenseStatus
object

Result of GetUserAndInstallationLicenceStatus Carrier object for UserAndInstallationLicenceStatus. Services for the UserAndInstallationLicenceStatus Carrier is available from the License Agent.

HasLicensce
object

Dictionary of license types and their status

SystemLicenseNames
string[]

Names of system licenses assigned to the user

UserSignedUpAt
string

Date and time when the user signed up

NumContact
integer<int32>

Number of contacts associated with the user

NumPerson
integer<int32>

Number of persons associated with the user

NumAppointment
integer<int32>

Number of appointments for the user

NumSale
integer<int32>

Number of sales associated with the user

NumProject
integer<int32>

Number of projects associated with the user

NumSelection
integer<int32>

Number of selections made by the user

NumEmailItem
integer<int32>

Number of email items associated with the user

NumTicketLogAction
integer<int32>

Number of ticket log actions performed by the user

NumDashboard
integer<int32>

Number of dashboards available to the user

NumQuote
integer<int32>

Number of quotes created by the user

NumQuoteLine
integer<int32>

Number of quote lines associated with the user

NumDocument
integer<int32>

Number of documents associated with the user

NumTargetAssignmentInfo
integer<int32>

Number of target assignment info records

NumMailing
integer<int32>

Number of mailings sent by the user

NumForm
integer<int32>

Number of forms created by the user

NumWorkflow
integer<int32>

Number of workflows associated with the user

TotContact
integer<int32>

Total number of contacts in the system

TotPerson
integer<int32>

Total number of persons in the system

TotAppointment
integer<int32>

Total number of appointments in the system

TotSale
integer<int32>

Total number of sales in the system

TotProject
integer<int32>

Total number of projects in the system

TotSelection
integer<int32>

Total number of selections in the system

TotEmailItem
integer<int32>

Total number of email items in the system

TotTicketLogAction
integer<int32>

Total number of ticket log actions in the system

TotDashboard
integer<int32>

Total number of dashboards in the system

TotQuote
integer<int32>

Total number of quotes in the system

TotQuoteLine
integer<int32>

Total number of quote lines in the system

TotDocument
integer<int32>

Total number of documents in the system

TotTargetAssignmentInfo
integer<int32>

Total number of target assignment info records

TotMailing
integer<int32>

Total number of mailings in the system

TotForm
integer<int32>

Total number of forms in the system

TotWorkflow
integer<int32>

Total number of workflows in the system

UserRegisteredAgeDays
integer<int32>

Number of days since the user registered

UserCountryName
string

Name of the user's country

UserCountryCode
string

Country code of the user

Preferences
object

Array of user preferences (name and value)

TotWebUsers
integer<int32>

Total number of web users in the system

GroupCountryName
string

Name of the group's country

GroupCountryCode
string

Country code of the group

GroupRegisteredDate
string

Date when the group was registered

GroupRegisteredAgeDays
integer<int32>

Number of days since the group was registered

FeatureToggles
object

Array of feature toggles (name and enabled status)

FileVersion
string

Current file version as a string

FileVersionNumber
integer<int32>

Current file version as a number