CONTENT
  thinking about it, please hold on..

API Terms & Concepts

Account

Accounts in Totango represent the YOUR customer. In a typical SaaS environment, this represents a tenant in your web-application to which users login.  Each account has a unique id which is used to normalize data from your web-application, CRM, data-warehouse or other systems.

 

User
User in Totango represents YOUR end-users. Totango keeps a track of all active users in an Account, measuring their engagement with your application and usage-frequency of key features.  Typically, an email address is used as user unique identifier (your internal user-id can also be used as an alternative).  

 

Account Attribute
Account attributes are extra pieces of information that can be associated with an account, and are later used in Totango for analysis and segmentation purposes. Attributes are updated on accounts either through API or directly from your Salesforce CRM, using the Totango Salesforce Data Connector.

 

Totango has a number of special Named Attributes which carry special meaning. Usually most of them are sourced directly from your CRM platform, but they can also be updated via the API (either Javascript or HTTP).



Name

Description

Field Type

Javascript example

HTTP example

Status

Free, Cancelled or the Plan-type the account is subscribed to. Read more

String

account: {

  ...

 Status: "ProPlus",

}

sdr_o.Status=ProPlus

Create Date

The time in which the account started its contract.

Date (ISO 8601 format)

account: {

...

"Create Date": "2011-12-20T19:25:58.0Z"

}



sdr_o.Create%20Date=2011-12-20T19:25:58.0Z

Contract Value

The contract value (in ARR or MRR) for the account

Number

account: {

...

"Contract Value”: 200000

}



sdr_o.Contract%20Value=200000

Contract Renewal Date

Use this attribute to indicate a contract expiration/renewal date if available

Date (ISO 8601 format)

account: {

...

"Contract Renewal Date": "2011-12-2”

}

sdr_o.Contract%20Renewal%20Date=2011-12-20

Licenses

Use this attribute to indicate the number of licenses this account has purchased (seat). Totango uses this value to compute the “license utilization”

Number

account: {

...

Licenses:  50

}

sdr_o.Licenses=50

 

User Attribute
User attributes are like account attributes but used for users.

 

Module
Modules are the main “areas” of your application, for example, if your app is an invoicing-application, it may have modules such as Invoicing, Billing or Reporting. You want Totango to know about the modules users visit, so you can later ask “which users didn’t use the Reporting module for over a month?”.

Make sure you have a clear definition of which action  and modules to track from your Totango administrator. 

Totango supports up to 100 modules, but works best with 3 - 10 modules defined. 

User action
A user action is something important users do on your web-app. In an invoicing application, it could be when users “Send an invoice” or “Deletes bank profiles”. When a user does them, it tells you something about the value they are getting from their account. You want Totango to know about user actions, so you can later ask “which users didn’t Send an invoice in the last 30 days?”

Make sure you have a clear definition of which action and modules to track from your Totango administrator. 

Totango supports up to 500 user-actions, but works best with 20 - 100. 

 

 

Have more questions? Submit a request

Comments

Follow
Powered by Zendesk