Engagement Scores

Engagement Scores

Returns a engagement score from the system by its ID.

This method will look up a engagement score by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the engagement score to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The engagement score was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The engagement score could not be found.
429Limit exceeded... unable to retrieve engagement score based on tenant limits.
500General server error.
get/engagementScores/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/engagementScores/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "customer_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "date": "string",
  • "components": [
    ],
  • "engagement_model_id": "string",
  • "total_score": 0,
  • "percentile_rank": 0,
  • "category_id": "string",
  • "date_of_first_engagement": "string",
  • "number_of_months_since_first_engagement": 0,
  • "previous_year_score": 0,
  • "previous_year_score_value_change": 0,
  • "previous_year_score_percentage_change": 0,
  • "previous_year_percentile_rank": 0,
  • "previous_year_percentile_rank_change": 0,
  • "md5_hash": "string",
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a list of records with the specified customer_id

Returns a list of records with the specified customer_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

customer_type
required
string

The customer_type to use to for record lookup

Enum: "contact" "organization"
customer_id
required
string

The customer_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/engagementScores/{tenantId}/customer/{customer_type}/{customer_id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/engagementScores/:tenantId/customer/:customer_type/:customer_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Get Raw Metric Data for Customer

Gets the raw metric data for a customer

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

customerType
required
string

The customer_type to use to for record lookup

Enum: "contact" "organization"
customerId
required
string

The customer_id to use to for record lookup

query Parameters
date
string

The optional date

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/engagementScores/{tenantId}/rawMetricData/{customerType}/{customerId}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/engagementScores/:tenantId/rawMetricData/:customerType/:customerId?date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "date": "string",
  • "metric_data": [
    ]
}

Initiate Engagement Metric Lookback

Initiates a lookback write of engagement-related data

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/engagementScores/{tenantId}/performLookback
Request samples
curl -i -X POST \
  https://rolodex.api.756794052567.rhythmsoftware.com/engagementScores/:tenantId/performLookback \
  -H 'Authorization: YOUR_API_KEY_HERE'

Regenerate scores

Regenerates scores when a scoring model has changed

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/engagementScores/{tenantId}/regenerateScores
Request samples
curl -i -X POST \
  https://rolodex.api.756794052567.rhythmsoftware.com/engagementScores/:tenantId/regenerateScores \
  -H 'Authorization: YOUR_API_KEY_HERE'

Get Metrics

Gets a list of all metrics

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/engagementScores/{tenantId}/metrics
Request samples
curl -i -X GET \
  https://rolodex.api.756794052567.rhythmsoftware.com/engagementScores/:tenantId/metrics \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]