Skip to content
YajraBox

Laravel DataTables
Icon

WARNING You're browsing the documentation for an upcoming version of Laravel DataTables. The documentation and features of this release are subject to change.

Object Response

The default response of Laravel DataTables is a JSON object. Use toJson() to convert the response to JSON format.

Basic Usage

use Yajra\DataTables\Facades\DataTables;
use App\Models\User;
 
Route::get('user-data', function() {
    $model = User::query();
 
    return DataTables::eloquent($model)
        ->addColumn('intro', 'Hi {{$name}}!')
        ->toJson();
});

Response Structure

{
    "draw": 2,
    "recordsTotal": 10,
    "recordsFiltered": 3,
    "data": [
        {
            "id": 476,
            "name": "Esmeralda Kulas",
            "email": "[email protected]",
            "created_at": "2016-07-31 23:26:14",
            "updated_at": "2016-07-31 23:26:14",
            "deleted_at": null,
            "superior_id": 0
        },
        {
            "id": 6,
            "name": "Zachery Muller",
            "email": "[email protected]",
            "created_at": "2016-07-31 23:25:43",
            "updated_at": "2016-07-31 23:25:43",
            "deleted_at": null,
            "superior_id": 1
        }
    ]
}

Response Parameters

Parameter Type Description
draw int Draw counter for DataTables
recordsTotal int Total records before filtering
recordsFiltered int Total records after filtering
data array Array of row objects
error string Error message if any (optional)

See Also

Edit this page on GitHub