Activities / Points

List Activity Points

Returns all Activity Points available in the user's ForceManager implementation database.

You will only receive the List of Activity Points after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.

HEADERS

ParameterValueDescription
Content-Typeapplication/jsonLanguage in which all request and response bodies are encoded
Accept*/*Any data of whatever mime type is accepted
X-Session-KeyAUTH_TOKENThis field must be completed with the token obtained at the authentication

RESPONSE

This endpoint returns all Activity Points that can be set, that are:

AttributeTypeDescription
IntervalDaysIntegerDays before today that will be used to calculate the Scores
PointsPerActivityIntegerPoints that the user will receive when performing an Activity that is not of "Visit" Type
PointsPerCheckinIntegerPoints that the user will receive when performing a "Checkin"
PointsPerEmailIntegerPoints that the user will receive for each received/sent "Email"
PointsPerInternalEmailIntegerPoints the user will receive for each "Email" they receive/send internal
PointsPerInternalPhoneCallMinuteIntegerPoints the user will receive depending on the duration of their internal "Calls"
PointsPerOpportunityIntegerPoints the user will receive for each Opportunity won
PointsPerPhoneCallMinuteIntegerPoints the user will receive depending on the duration of their "Calls"
PointsPerSalesOrderIntegerPoints that the user will receive for each Order won
PointsPerVisitIntegerPoints that the user will receive when performing an Activity of "Visit" Type
SalesInputIntegerThe sales will be calculated: 0 -> with customized Z_viewsalesuser. If 1 -> With won Opportunities. If 2 -> With won Quotes. If 3 -> With won sales Orders
ScoringPerEnvironmentInteger0 -> the scores will be relative to the all implementation. If different than 0 the scores will be relative to the Branch

RESPONSE CODES

StatusDescription
200 OKShows if operation succeeded
400 Bad RequestShows when an invalid request or the requested service is not available
get/activity/points

Request

  • Base URL: https://api.forcemanager.com/api/v4
  • URL: https://api.forcemanager.com/api/v4/activity/points
  • Auth: API key in header X-Session-Key

Headers

Acceptstring

Response

List activity points

Changes

No recorded changes to this operation across all 1 revision of this API.