Releases
Get Release Report
How one release compares with the week before it: errors, web vitals, engagement, key events and what else changed. Any build id of the release finds it.
GET
How one release compares with the week before it: errors, web vitals, engagement, key events and what else changed. Any build id of the release finds it.
apiKeyAuthheader
x-api-key<token>FastStats API key. Pass it in the x-api-key header or as a Bearer token in the Authorization header.
idOrSlug*stringreleaseId*stringSuccess
application/json- response
release*previous*|nullnext*|nullbaseline*live*metrics*array<>events*array<>issues*array<>changes*array<>commits*|nullhighlights*array<string>curl -X GET 'https://api.faststats.dev/v0/projects/string/releases/string'Example Response
{ "release": { "id": "string", "shortId": "string", "buildIds": [ "string" ], "deployedAt": "string", "replacedAt": "string", "verdict": "regressed", "reasons": [ "string" ], "sessions": 0, "errorSessions": 0, "newIssues": 0, "newIssueSessions": 0 }, "previous": { "id": "string", "shortId": "string", "deployedAt": "string" }, "next": { "id": "string", "shortId": "string", "deployedAt": "string" }, "baseline": { "from": "string", "to": "string" }, "live": { "from": "string", "to": "string", "ongoing": true }, "metrics": [ { "key": "string", "label": "string", "group": "traffic", "unit": "count", "better": "lower", "before": 0, "after": 0, "beforeSamples": 0, "afterSamples": 0, "change": 0, "assessment": "worse" } ], "events": [ { "key": "string", "label": "string", "group": "traffic", "unit": "count", "better": "lower", "before": 0, "after": 0, "beforeSamples": 0, "afterSamples": 0, "change": 0, "assessment": "worse" } ], "issues": [ { "issueId": "string", "kind": "new", "errorType": "string", "errorMessage": "string", "sessions": 0, "occurrences": 0, "expected": 0, "firstSeen": "string" } ], "changes": [ { "kind": "feature_flag", "at": "string", "title": "string", "detail": "string" } ], "commits": { "items": [ { "sha": "string", "message": "string", "author": "string", "url": "string" } ], "total": 0, "compareUrl": "string" }, "highlights": [ "string" ]}GET
curl -X GET 'https://api.faststats.dev/v0/projects/string/releases/string'{
"release": {
"id": "string",
"shortId": "string",
"buildIds": [
"string"
],
"deployedAt": "string",
"replacedAt": "string",
"verdict": "regressed",
"reasons": [
"string"
],
"sessions": 0,
"errorSessions": 0,
"newIssues": 0,
"newIssueSessions": 0
},
"previous": {
"id": "string",
"shortId": "string",
"deployedAt": "string"
},
"next": {
"id": "string",
"shortId": "string",
"deployedAt": "string"
},
"baseline": {
"from": "string",
"to": "string"
},
"live": {
"from": "string",
"to": "string",
"ongoing": true
},
"metrics": [
{
"key": "string",
"label": "string",
"group": "traffic",
"unit": "count",
"better": "lower",
"before": 0,
"after": 0,
"beforeSamples": 0,
"afterSamples": 0,
"change": 0,
"assessment": "worse"
}
],
"events": [
{
"key": "string",
"label": "string",
"group": "traffic",
"unit": "count",
"better": "lower",
"before": 0,
"after": 0,
"beforeSamples": 0,
"afterSamples": 0,
"change": 0,
"assessment": "worse"
}
],
"issues": [
{
"issueId": "string",
"kind": "new",
"errorType": "string",
"errorMessage": "string",
"sessions": 0,
"occurrences": 0,
"expected": 0,
"firstSeen": "string"
}
],
"changes": [
{
"kind": "feature_flag",
"at": "string",
"title": "string",
"detail": "string"
}
],
"commits": {
"items": [
{
"sha": "string",
"message": "string",
"author": "string",
"url": "string"
}
],
"total": 0,
"compareUrl": "string"
},
"highlights": [
"string"
]
}