Returns a list of all analytics_engine_tasks belonging to an account as per the specified criteria. This API is paginated and returns 20 groups by default. A analytics_engine_task is uniquely identified by a 'analytics_engine_task_key'. This key should be used in all the other API referencing a particular analytics_engine_task.

Params

Param name Description
page
optional

Page number of results to be fetched, Default 1


Value: Must be Integer.
per
optional

Number of analytics_engine_task records to be returned in one page, Default 20


Value: Must be Integer.
order_by
optional

Field on which results should be sorted


Value: Must be a String
order
optional

Order, “asc” or “desc”, in which results should be sorted.


Value: Must be a String
timestamp_format
optional

Format, “str” or “int”, in which timestamps should be returned, Default “int”


Value: Must be a String
search
optional

Keywords based on which analytics_engine_tasks should be searched. Currently you can search analytics_engine_tasks on - analytics_engine_key or name


Value: Must be a String
scope
optional

Matching condition if multiple keywords are specified for search. Valid values are “all” or “any”. Default is “all”


Value: Must be a String
pretty
optional

Return a pretty formatted response if true, Default is false


Value: Must be a Boolean
field_list
optional

List of fields required in the result.


Value: Must be an array of any type

Examples

Request - listing all analytics_engine_tasks without any criteria
  curl -X GET -H "Content-Type:application/json" -H "X-Auth-Token:DarTKU-eUJ7md2vS-lFroA" https://datonis.altizon.com/api/v3/analytics_engine_tasks

Response (returns first 20 analytics_engine_tasks)
{
  "total_count": 2,
  "page": 1,
  "analytics_engine_tasks": [
    {
      "analytics_engine_task_key": "dc9af8e4ec",
      "name": "AnalyticsEngineTask",
      "recurring": false,
      "task_recurring_frequency": 43200,
      "task_start_time": 1440063339,
      "task_timeout": 1800,
      "analytics_engine_key": "e119d453c2"
    },
    {
      "analytics_engine_task_key": "dc9af8e4ed",
      "name": "AnalyticsEngineTask2",
      "recurring": false,
      "task_recurring_frequency": 43200,
      "task_start_time": 1440063339,
      "task_timeout": 1800,
      "analytics_engine_key": "e119d453c5"
    }
  ]
}