-
Notifications
You must be signed in to change notification settings - Fork 0
Report REST API
Welcome to the Data Cortex Report API version 1.
This API allows accessing the reporting and meta-data of the Data Cortex system.
All calls are made on the standard data ingestion endpoint:
https://report.data-cortex.com
Retrieve a session_key for future communication with the API. Will generate an email to the specified address to authenticate the user. The email will contain a verification URL that should be clicked to enable the session_key for access to the API. You will need to record and enter the manual_code on that web page as well.
POST /api/1/login
email - string - Email address of user to authenticate
200 OK
result - string - "new_browser" - Indicates a new authentication
session_key - string - Session key for this login. Should be sent in a cookie or body of subsquent API calls.
manual_code - string - Manual code for the verification process.
Disabled the current session.
POST /api/1/logout
None
200 OK
Successfully disabled the session_key.
Get information about the logged in user.
GET /api/1/user
None
200 OK
user_id - number - User ID
email - string - User email address
display_name - string - User display name
org_list - list of objects - List of organizations this user belongs to
-
org_id - number - Organization ID
-
name - string - Organization name
403 Forbidden
Not logged in
List all application for this organization.
GET /api/1/app
org_id - string - Organization ID
200 OK
app_list - list of objects - List of applications
-
app_id - number - Application ID
-
name - string - Application name
-
api_key_list - list of string - List of API keys for this application
403 Forbidden
Not allowed to list that organizations applications.
Create application.
GET /api/1/app
org_id - string - Organization ID
app_name - string - Application Name
200 OK
app_id - number - Application ID
403 Forbidden
Not allowed to add an application that organization.
Delete application
DELETE /api/1/app/:app_id
app_id - string - Application ID
200 OK
Application deleted.
403 Forbidden
Not allowed to delete that application.