Skip to main content
GET
Get User Activity Metric

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Path Parameters

id
string
required

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Response

Response for status 200

id
string
required
userId
string | null

Present unless the request's fields leaves it out.

periodStart
string<date>

Present unless the request's fields leaves it out.

periodEnd
string<date>

Present unless the request's fields leaves it out.

activityType
string

Present unless the request's fields leaves it out.

activityTypeName
string

Present unless the request's fields leaves it out.

value
number

Present unless the request's fields leaves it out.

unit
enum<string>

Present unless the request's fields leaves it out.

Available options:
count,
minutes,
hours
breakdown
object[] | null

How much of value was for each deal, and the contact on it, in unit. A split of value, never added to it: what the entries leave is the activity the source didn't link to a deal. An id is null when that deal or contact isn't synced, and the entry keeps its value. [] when the source can link activity to deals and linked none; null when it can't link this activity to deals at all. Only Sisu fills it today; every other app returns [] for now, which doesn't mean its activity was unlinked. Present unless the request's fields leaves it out.

created
string<date-time> | null

Present unless the request's fields leaves it out.

updated
string<date-time> | null

Present unless the request's fields leaves it out.

rolloutUpdated
string<date-time>

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.