The latest version for DAS is WSO2 Data Analytics Server 3.2.0. View documentation for the latest release.
WSO2 Data Analytics Server is succeeded by WSO2 Stream Processor. To view the latest documentation for WSO2 SP, see WSO2 Stream Processor Documentation.
||
Skip to end of metadata
Go to start of metadata

The following are the REST APIs that are implemented in WSO2 DAS 3.0.0. 

FunctionREST API
Checking if a table existsGET /analytics/table_exists?table={tableName}
Listing all tablesGET /analytics/tables
Retrieving records of a tableGET /analytics/tables/{tableName}/{from}/{to}/{start}/{count}
Getting the record count of a tableGET /analytics/tables/{tableName}/recordcount
Searching records of a tablePOST /analytics/search
Getting the search record count of a tablePOST /analytics/search_count
Timing out the indexing process completionGET /analytics/indexing_done?timeout=<long-value>
Defining/updating the schema of a tablePOST /analytics/tables/{tableName}/schema
Getting the schema of a tableGET /analytics/tables/{tableName}/schema
Drilling down through hierarchical categoriesPOST /analytics/facets
Retrieving matching records through a drill down searchPOST /analytics/drilldown
Retrieving the count of matching records through a drill down searchPOST/analytics/drillDownScoreCount
Retrieving records using given primary key value pairsPOST/analytics/tables/{tableName}/keyed_records
Retrieving All Record StoresGET /analytics/recordstores
Retrieving the Record Store of a Given TableGET /analytics/recordstore?table={tableName}
Checking if the Given Records Store Supports PaginationGET /analytics/pagination/<recordstore-name>
Tracking the Indexing Process Completion of a TableGET /analytics/indexing_done?maxWait=10&table={tableName}
Retrieving Aggregated Values of Given RecordsPOST /analytics/aggregates
Retrieving the Event Count of Range FacetsPOST /analytics/rangecount
Clear Index Information of a Given TableDELETE /analytics/tables/{tableName}/indexData

The REST APIs are secured with basic authentication. Therefore, follow the steps below to add a basic auth header when calling these methods.

  1. Build a string of the form username:password.
  2. Encode the string you created above using Base64. For encoding the above string using Base64, see Encode to Base64 format.
  3. Define an authorization header with the term "Basic_", followed by the encoded string. For example, the basic auth authorization header using "admin" as both username and password is as follows: 
    Authorization: Basic YWRtaW46YWRtaW4=

Cross-Origin Resource Sharing (CORS) should be enabled if you are using analytics REST API from outside the DAS domain, or if the REST API caller is situated in a machine with a different host/port configuration to WSO2 DAS. For more information, see CORS Settings for the Analytics REST API.

  • No labels
  • Download PDF icon Download PDF
  • Download a PDF file of the documentation