Canary Analysis Report
    • PDF

    Canary Analysis Report

    • PDF

    Article Summary

    The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

    Summary

    Search the SourceDeploy canary analysis report.

    Request

    API URL

    GET 	{SOURCEDEPLOY_API_URL}/project/{projectId}/history/{historyId}/report/{endTime}
    

    Request parameter

    ItemTypeDescriptionRemarks
    projectIdstringProject IDSearch projectList
    historyIdstringHistory IDSearch historyList
    endTimestringCanary analysis step timeSearch canaryAnalysisList

    Request query

    None

    Request body

    None

    Response

    Response body

    {
        "status": "string",
        "score": "number",
        "passScore": "number",
        "start": "number",
        "end": "number",
        "step": "number",
        "metricList": [
            {
                "metricId": "number",
                "metricName": "string",
                "weight": "number",
                "elementList": [
                    {
                        "name": "string",
                        "element": "string",
                        "deviation": "number",
                        "status":  "pass"  /  "fail",
                        "base": {
                            "start": "number",
                            "end": "number",
                            "count": "number",
                            "avg": "number",
                            "max": "number",
                            "min": "number"
                        },
                        "canary": {
                            "start": "number",
                            "end": "number",
                            "count": "number",
                            "avg": "number",
                            "max": "number",
                            "min": "number"
                        }
                    }
                ]
            }
        ]
    }
    
    ItemTypeDescriptionRemarks
    statusstringStatus"pass" | "fail"
    scorenumberTotal score
    passScorenumberPassing score
    startnumberAnalysis start time
    endnumberAnalysis end time
    stepnumberData collection period
    metricList.metricIdnumbermetric id
    metricList.metricNamestringMetric name
    metricList.weightnumberWeight
    metricList.elementList.namestringElement name
    metricList.elementList.elementstringelement
    metricList.elementList.deviationnumberElement deviation
    metricList.elementList.statusstringElement status"pass" | "fail"
    metricList.elementList.base.startnumberBaseline analysis start time
    metricList.elementList.base.endnumberBaseline analysis end time
    metricList.elementList.base.countnumberNumber of baseline collection data
    metricList.elementList.base.avgnumberAverage value of baseline
    metricList.elementList.base.maxnumberMaximum value of baseline
    metricList.elementList.base.minnumberMinimum value of baseline
    metricList.elementList.canary.startnumberCanary analysis start time
    metricList.elementList.canary.endnumberCanary analysis end time
    metricList.elementList.canary.countnumberNumber of canary collection data
    metricList.elementList.canary.avgnumberAverage value of canary
    metricList.elementList.canary.maxnumberMaximum value of canary
    metricList.elementList.canary.minnumberMinimum value of canary

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.