Description
Remove percentiles and sessionMaxPercentiles fields from api/v2/journey/sessions/{sessionId}/outcomescores contract
Change Category
API
Change Context
These fields were added in November but never populated. We wish to remove them to avoid confusion. We will be going a different route with separate float quantile fields instead which are more future-proofed.
Change Impact
No impact: there is no usage of this resource. Additionally, the service that would be responsible for populating these fields was never updated to populate them.
The database that directly backs the API does not contain any attribute or any other reference to percentile.
These fields default to omitted and do not show up in API responses at all. E.g.:
curl [https://api.inindca.com/api/v2/journey/sessions/83b7160b-9a83-47d0-ab29-86075c99cfde/outcomescores|https://api.inindca.com/api/v2/journey/sessions/83b7160b-9a83-47d0-ab29-86075c99cfde/outcomescores] -H 'Authorization: Bearer rkSqeOpT1D0Pponj-Iv9ieDAX94gJv-GkXOQIwZ1FQCqo_rrTFgtJxpuBytCOeehk1WVMce-3CL57Emvx7UrBQ' | jq
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 408 100 408 0 0 1000 0 --:--:-- --:--:-- --:--:-- 1014
{
"outcomeScores": [
{
"outcome": {
"id": "c3b8aec9-c4af-4432-8f0d-1e0f304422f1",
"selfUri": "/api/v2/journey/outcomes/c3b8aec9-c4af-4432-8f0d-1e0f304422f1"
},
"sessionMaxProbability": 7.9113925e-05,
"probability": 6.211952e-05
},
{
"outcome": {
"id": "f0c5d061-fc70-4d00-83c4-56d3ea5bad94",
"selfUri": "/api/v2/journey/outcomes/f0c5d061-fc70-4d00-83c4-56d3ea5bad94"
},
"sessionMaxProbability": 0.041221373,
"probability": 0.018946452
}
]
}
Date of Change
Augyst 10th, 2023
Impacted APIs
/api/v2/journey/sessions/{sessionId}/outcomescores
References
[AP-15962]