Event_DT.adoc

Data Tables - Events DataTable

Used by the JavaScript datatable to return event log records.

Table of Contents

• Introduction
• Request
• Response
  • Root
• Examples
  • Get Events

Introduction

Used by the JavaScript datatable (see http://legacy.datatables.net/usage/server-side) to return event log records. iDisplayLength sets the number of records to return (defaults to 1) and if set to -1 will return all records.

Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.

More details on the project are available from the project’s homepage.

Request

A HTTP GET to the /datatab/event_dt.rb endpoint provides the following response data.

As of recent Gateway software versions this request requires user authentication and authorisation, see Authentication.

Response

Root

Name	Type	Values	Description
iTotalRecords	Number	Number	Total records, before filtering (i.e. the total number of records in the database).
recordsTotal	Number	Number	Total number of records.
iTotalDisplayRecords	Number	Number	Total records, after filtering (i.e. the total number of records after filtering has been applied - not just the number of records being returned in this result set).
recordsFiltered	Number	Number	The number of records after filtering?
aaData	Array(Unknown)	Array of Unknown	The data in a 2D array (event_id, event_desc, serial_num, device_type, event_date).

Examples

Get Events

GET /datatab/event_dt.rb Response

{"iTotalRecords": 500, "recordsTotal": 500, "iTotalDisplayRecords": 500, "recordsFiltered": 500, "aaData": [["16326", "Microinverter failed to report: Set", "123456789111", "pcu ", "Sat Jun 03, 2023 09:30 PM BST"]]}