The analyses-api provides APIs that enable you to perform data analyses on csv data.
\nCurrently there are provisions for:
\nwith support for many more analyses operation coming along.
\nTo start using analyses APIs, you need to -
\nThe analyses-api API uses bearer token for authentication. You can generate an authentication token by sign in to a created account.
\n\nYou must include an API key in each request to the files and analyses endpoints with the
\nAuthorizationrequest header.
If authentication token is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17081738","collectionId":"6be39552-933b-4d00-9d42-67d3f65fefd3","publishedId":"2s9YsT6oZJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-20T12:50:13.000Z"},"item":[{"name":"User","item":[{"name":"Register user","id":"62b637ba-b8e4-43f3-a4f5-4a13316fd86b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"Anonymous\",\n \"email\": \"anonymous@email.com\",\n \"password\": \"asdf;lkj0\"\n}","options":{"raw":{"language":"json"}}},"url":"https://analyses-api.onrender.com/users/register","description":"creates new user in the database using the data in the body of the request. The endpoint expects a POST request with a json body with the following key:
\n{\n \"username\": \"****\" // alphanumeric user's username\n \"password\": \"****\" // atleat 8 character user's password\n \"email\": \"****\" // user's email\n}\n\nThe request returns response with the following http status codes:
\n200 - status OK:
with response body:
\n {\n \"user\": {\n \"username\":\"****\",\n \"email\": \"*****\",\n \"password_changed_at\": \"*****\",\n \"created_at\": \"*****\"\n },\n \"error\":\"\"\n }\n\n400 - status Bad Request:
with response body:
\n {\n \"user\": {},\n \"error\": \"*****\"\n }\n\n403 - status Forbidden:
with response body:
\n {\n \"user\": {},\n \"error\": \"*****\"\n }\n\n501 - status Internal Server Error:
with response body:
\n {\n \"user\": {},\n \"error\": \"*****\"\n }\n\nGets information about the authenticated user.
\nThe endpoint expects a GET request with a json body with the following key:
\n{\n \"username\": \"****\" // alphanumeric user's username\n \"password\": \"****\" // atleat 8 character user's password\n}\n\nThe request returns response with the following http status codes:
\n200 - status OK:
with response body:
\n{\n \"access_token\": \"*****\",\n \"user\": {\n \"username\":\"****\",\n \"email\": \"*****\",\n \"password_changed_at\": \"*****\",\n \"created_at\": \"*****\"\n },\n \"error\":\"\"\n}\n\n400 - status Bad Request:
with response body:
\n {\n \"access_token\": \"\",\n \"user\": {},\n \"error\": \"*****\"\n }\n\n404 - status Not Found:
with response body:
\n {\n \"access_token\": \"\",\n \"user\": {},\n \"error\": \"*****\"\n }\n\n401 - status Unauthorized:
with response body:
\n {\n \"access_token\": \"\",\n \"user\": {},\n \"error\": \"*****\"\n }\n\n501 - status Internal Server Error:
with response body:
\n {\n \"user\": {},\n \"error\": \"*****\"\n }\n\nThe /users/ endpoints gives you access to the services, allowing you to create an account, and sign in to created accounts.
uploads encoded user data to the database using the data in the body of the request. If a user has a file in the database, the new file replaces the old file in the database. The endpoint expects a POST request with a form-data body with the following key:
\n`username` - alphanumeric user's username\n`file` - a csv file.\n\nThe request returns response with the following http status codes:
\n200 - status OK:
with response body:
\n {\n \"file\": {\n \"id\":\"****\",\n \"changed_at\": \"*****\",\n },\n \"error\":\"\"\n }\n\n400 - status Bad Request:
with response body:
\n {\n \"file\": {},\n \"error\": \"*****\"\n }\n\n401 - status Unauthorized:
{\n \"file\": {},\n \"error\": \"*****\"\n }\n\n413 - status Request Entity Too Large:
with response body:
\n {\n \"file\": {},\n \"error\": \"*****\"\n }\n\n501 - status Internal Server Error:
with response body:
\n {\n \"file\": {},\n \"error\": \"*****\"\n }\n\nThe /files/ endpoints gives you access to upload data to be used for analysis.
Gets information about the authenticated user.
\nThe endpoint expects a GET request with a json body with the following key:
\n{\n \"username\": \"****\" // alphanumeric user's username\n}\n\nThe request returns response with the following http status codes:
\n200 - status OK:
with response body:
\n{\n \"regression_coefficients\": \"****\",\n \"t-test statistics\": \"****\",\n \"error\": \"\"\n}\n\n400 - status Bad Request:
with response body:
\n{\n \"regression_coefficients\": \"\",\n \"t-test statistics\": \"\",\n \"error\": \"****\"\n}\n\n401 - status Unauthorized:
with response body:
\n{\n \"regression_coefficients\": \"\",\n \"t-test statistics\": \"\",\n \"error\": \"****\"\n}\n\n501 - status Internal Server Error:
with response body:
\n{\n \"regression_coefficients\": \"\",\n \"t-test statistics\": \"\",\n \"error\": \"****\"\n}\n\nThe /analyses/ endpoints gives you access to perform data analysis on uploaded csv data.