scores

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-scores"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/d3d23010-adbe-427d-b622-102d526ba405/social-card.svg?v=3e7ae33eec8b" alt="scores" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/scores

Parameters

limitintegerquery
= 50
cursorstringquery
statusstringquery
draft | active | inactive

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/scores" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "key": "string",
      "status": "draft",
      "draft": {
        "rules": [],
        "actions": [],
        "decay": {
          "points": 0,
          "everyDays": 0
        },
        "floor": 0,
        "ceiling": 0,
        "groups": [],
        "tiers": []
      },
      "published": {
        "rules": [],
        "actions": [],
        "decay": {
          "points": 0,
          "everyDays": 0
        },
        "floor": 0,
        "ceiling": 0,
        "groups": [],
        "tiers": []
      },
      "publishedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem65[]required
Show child parameters
idstringrequired
namestringrequired
keystringrequired
statusstringrequired
draft | active | inactive
draftobjectrequired
Show child parameters
rulesRulesItem3[]required
= []
actionsActionsItem[]required
= []
decayobject
floorintegerrequired
= 0
ceilinginteger
groupsGroupsItem[]required
= []
tiersTiersItem[]required
= []
publishedobjectrequired
Show child parameters
rulesRulesItem3[]required
= []
actionsActionsItem[]required
= []
decayobject
floorintegerrequired
= 0
ceilinginteger
groupsGroupsItem[]required
= []
tiersTiersItem[]required
= []
publishedAtstringrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/scores

POSThttps://hermeticor.com/v1/scores

Request body

application/json
namestringrequired
keystringrequired
definitionobject
Show child parameters
rulesRulesItem4[]
= []
actionsActionsItem2[]
= []
decayobject
Show child parameters
pointsintegerrequired
everyDaysintegerrequired
floorinteger
= 0
ceilinginteger
groupsGroupsItem2[]
= []
Show child parameters
idstringrequired
namestringrequired
limitinteger
tiersTiersItem2[]
= []
Show child parameters
labelstringrequired
minintegerrequired
{
  "name": "string",
  "key": "string",
  "definition": {
    "rules": [],
    "actions": [],
    "decay": {
      "points": 0,
      "everyDays": 0
    },
    "floor": 0,
    "ceiling": 0,
    "groups": [],
    "tiers": []
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/scores" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","key":"string","definition":{"rules":[],"actions":[],"decay":{"points":0,"everyDays":0},"floor":0,"ceiling":0,"groups":[],"tiers":[]}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "key": "string",
  "status": "draft",
  "draft": {
    "rules": [],
    "actions": [],
    "decay": {
      "points": 0,
      "everyDays": 0
    },
    "floor": 0,
    "ceiling": 0,
    "groups": [],
    "tiers": []
  },
  "published": {
    "rules": [],
    "actions": [],
    "decay": {
      "points": 0,
      "everyDays": 0
    },
    "floor": 0,
    "ceiling": 0,
    "groups": [],
    "tiers": []
  },
  "publishedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
keystringrequired
statusstringrequired
draft | active | inactive
draftobjectrequired
Show child parameters
rulesRulesItem3[]required
= []
actionsActionsItem[]required
= []
decayobject
Show child parameters
pointsintegerrequired
everyDaysintegerrequired
floorintegerrequired
= 0
ceilinginteger
groupsGroupsItem[]required
= []
Show child parameters
idstringrequired
namestringrequired
limitinteger
tiersTiersItem[]required
= []
Show child parameters
labelstringrequired
minintegerrequired
publishedobjectrequired
Show child parameters
rulesRulesItem3[]required
= []
actionsActionsItem[]required
= []
decayobject
Show child parameters
pointsintegerrequired
everyDaysintegerrequired
floorintegerrequired
= 0
ceilinginteger
groupsGroupsItem[]required
= []
Show child parameters
idstringrequired
namestringrequired
limitinteger
tiersTiersItem[]required
= []
Show child parameters
labelstringrequired
minintegerrequired
publishedAtstringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/scores

5XX Default Response

Same as 4XX · GET /v1/scores

GEThttps://hermeticor.com/v1/scores/values

Every score value one contact holds

Parameters

profileIdstringqueryrequired
limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/scores/values?profileId=<profileId>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "modelId": "string",
      "profileId": "string",
      "value": 0,
      "updatedAt": "2024-01-01T00:00:00Z",
      "fit": 0,
      "engagement": 0,
      "tier": null
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
modelIdstringrequired
profileIdstringrequired
valueintegerrequired
updatedAtstringrequired
fitintegerrequired
= 0
engagementintegerrequired
= 0
tierstringrequired
= null
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/scores

5XX Default Response

Same as 4XX · GET /v1/scores

GEThttps://hermeticor.com/v1/scores/history

Why a contact's score moved, newest first

Parameters

limitintegerquery
= 50
cursorstringquery
profileIdstringqueryrequired
modelIdstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/scores/history?profileId=<profileId>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "modelId": "string",
      "profileId": "string",
      "delta": 0,
      "value": 0,
      "reason": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
modelIdstringrequired
profileIdstringrequired
deltaintegerrequired
valueintegerrequired
reasonstringrequired
atstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/scores

5XX Default Response

Same as 4XX · GET /v1/scores

GEThttps://hermeticor.com/v1/scores/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/scores/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/scores

4XX Default Response

Same as 4XX · GET /v1/scores

5XX Default Response

Same as 4XX · GET /v1/scores

DELETEhttps://hermeticor.com/v1/scores/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/scores/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/scores

5XX Default Response

Same as 4XX · GET /v1/scores

Updated