---
title: "Returns regression analysis."
method: POST
path: "/regression/api"
---

# Returns regression analysis.

`POST /regression/api`

## Request body

- RegressionApiBody
  - `key` string, required — api key
  - `outcome_variable` string, required — name of the desired outcome variable
  - `ignore_variables` object[]
  - `convert_date_to` string — convert dates to either month (1-12) or week (1-52)
  - `data` object[], required

## Response `200`

A JSON array of data

- union
  - Result
    - `outcome_variable` string — the name of the variable processed as the outcome
    - `summary` object[]
    - `paid` string — yes if paid subscriber, otherwise no
    - `header` string — text for pdf header
    - `footer` string — text for pdf footer
    - `data_count` integer — number of data rows processed
    - `number_observations` integer — number of data rows used for analysis
    - `number_tests` integer — number of data rows used to test model accuracy
    - `prediction_mean_accuracy` integer — percentage accuracy of model created
    - `tested_variables` string[]
    - `dates_converted_to` string — either month or week
    - `calls"` ResultCalls
      - `limit_reached` boolean — true if monthly limit has been reached
      - `this_month` integer — number of api calls this month
      - `limit` integer — number of api calls allowed per month
    - `standardized_coefficients` ResultStandardizedCoefficients[]
      - `variable` string — name of variable
      - `coefficient` integer — standardized regression coefficient for variable
    - `pdf` string — url of pdf summary
  - Error
    - `error` string — an error description

---

[API](https://skmtc.dev/scideas/apis/regression-analysis-api.md) · [All operations](https://skmtc.dev/scideas/apis/regression-analysis-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scideas/regression-analysis-api/revisions/3dea43a02dec/schema)