SymetryML Documentation
Kaplan meier

Get survival frames

Returns every group's survival frame from the project's Kaplan-Meier online representation under `values.sdfResults`. Takes no request body. - **`sdfmap`**: keyed by group value (e.g. `"0"`, `"1"`, `"2"`) plus the aggregate `"Total"` group. - Each group's **`DataFrame`** has columns `time`, `at_risk`, `event`, `survival_func`, and the lower/upper confidence-interval bounds (`[0.025`, `0.975]` at the default 95% level). - A project that has a Kaplan-Meier representation but no built model returns an empty `sdfmap`.

GET
/{user}/projects/{project}/km/getSurvivalFrame

Returns every group's survival frame from the project's Kaplan-Meier online representation under values.sdfResults. Takes no request body.

  • sdfmap: keyed by group value (e.g. "0", "1", "2") plus the aggregate "Total" group.
  • Each group's DataFrame has columns time, at_risk, event, survival_func, and the lower/upper confidence-interval bounds ([0.025, 0.975] at the default 95% level).
  • A project that has a Kaplan-Meier representation but no built model returns an empty sdfmap.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

project*string

Project identifier

Response Body

application/json

application/json

curl -X GET "https://example.com/c1/projects/nbra_prj_iris/km/getSurvivalFrame"

{  "statusCode": 200,  "statusString": "OK",  "values": {    "sdfResults": {      "sdfmap": {        "0": {          "attributeNames": [            "time",            "at_risk",            "event",            "survival_func",            "[0.025",            "0.975]"          ],          "attributeTypes": [            "C",            "C",            "C",            "C",            "C",            "C"          ],          "data": [            [              "0",              "77",              "0",              "1.0",              "1.0",              "1.0"            ],            [              "30",              "77",              "1",              "0.987012987012987",              "0.9113749048962433",              "0.9981603408625513"            ]          ]        }      }    }  }}

{  "statusCode": 500,  "statusString": "Generic Exception [java.lang.Exception: Project my-project has no KaplanMeierOnlineRep]",  "values": {}}

Get job status GET

Get the status of one job by id. Returns `202` while the job is still running and `200` once it has finished, with a job-type-specific result attached in `values` alongside `jobinfo` (e.g. `values.smlInfo` for a `dsUpdate` job).

Kaplan-Meier prediction POST

Runs one or more Kaplan-Meier survival queries against the project's fitted KM model. Each query in `values` has: - **`type`**: only `survival` is supported. - **`times`**: required array of time points to evaluate. - **`group`** (optional): if omitted/empty, results for every group (including the aggregate `"Total"` group) are returned instead of just one. - **`alpha`** (optional): confidence level; defaults to `0.05`, must satisfy `0 < alpha < 1`. Results are returned under `values.kmResultList.values`, one entry per query in request order; each entry is an object keyed by group name whose value is the prediction `DataFrame`.