Reports

Reports API documentation

Download Reports OpenAPI Document

End Points

GET

/reports/{id}/data/total-count

POST

/reports/{id}/export

GET

/reports/{id}/export_settings

PUT

/reports/{id}/export_settings

POST

/reports/{id}/send-email

Attribute

inputs

object

Show Sub-Attributes

domains

array

Show Sub-Attributes

string

Domain ID

ous

object

Object to specify selected and unselected OUs

Show Sub-Attributes

selected

array

List of selected OUs ID

unselected

array

List of unselected OUs ID

exclude_child_ou

boolean

A flag to specify exclusion of child OUs

domain

object

Show Sub-Attributes

string

Domain ID

ous

object

Object to specify selected and unselected OUs

Show Sub-Attributes

selected

array

List of selected OUs ID

unselected

array

List of unselected OUs ID

exclude_child_ou

boolean

A flag to specify exclusion of child OUs

period

object

No of days input - used in date based reports

Show Sub-Attributes

days

integer

No of days

range

string

Range of days

start_date

string

Start date of range

end_date

string

End date of range

duration

object

Used in logon hours report

Show Sub-Attributes

days

array

Array of days

from

string

selected value in hour

string

selected value in hour

group_type

string

Used in group type and scope reports.

Allowed Values:

distribution
security

group_scope

string

Used in group type and scope reports

Allowed Values:

global
domain_local
universal

attribute

string

Used in attribute based reports

matching_criteria

string

Matching criteria for attribute based reports

Allowed Values:

matchAll
matchAny

photo_based_selected

object

Used in photo based reports

Show Sub-Attributes

user_based_photo

string

Used in photo based reports to specify user based photo

Allowed Values:

userWithPhoto
userWithOutPhoto

user_based_photo_attribute

string

Used in photo based reports to specify user based photo attribute

Allowed Values:

thumbnailPhoto
thumbnailLogo
photo

logon_permission

string

Used in logon hour based reports

top

integer

Used in Top N Big groups

exclude_disabled_users

boolean

Used in reports having advanced filter dropdown checkbox

never_logged_on_users

boolean

Used in reports having advanced filter dropdown checkbox

account_expired_users

boolean

Used in reports having advanced filter dropdown checkbox

based_on

string

Used in reports having advanced filter dropdown checkbox

groups

array

Used in popup input based reports for groups

exclude_nested_groups

boolean

Used in reports having advanced filter dropdown checkbox

users

array

Array of user IDs for manager report, array of manager user IDs.

attributes

array

Used in popup input based reports based on attribute IDs

array

Array of OS Ids for OS based reports

policies

array

Array of policy Ids for policy based reports

view_columns

array

List of columns to be displayed in the report view.

criteria_filter

object

Show Sub-Attributes

rows

array

Show Sub-Attributes

appId

string

The application ID associated with the criteria.

field_id

string

The ID of the field being filtered.

display_name

string

The display name of the field.

operator_id

string

The ID of the operator used for filtering.

operator_display_name

string

The display name of the operator.

logic_operator

string

The logical operator used in the criteria (e.g., AND, OR).

logic_operator_display_name

string

The display name of the logical operator.

rowType

string

Type of row, e.g., 'row'.

type

string

Type of criteria, e.g., '2000000092896'.

value_component_id

string

Component ID for the value input.

value_object

string

The value associated with the criteria.

pattern

string

A string representation of the logical structure of the criteria.

{
    "inputs": {
        "domains": [
            {
                "id": "200090909090",
                "ous": {
                    "selected": [
                        20000909435000,
                        20000909435030,
                        20000909435004
                    ],
                    "unselected": [
                        20000909435900,
                        20000082399090
                    ],
                    "exclude_child_ou": false
                }
            }
        ],
        "domain": {
            "id": "200090909090",
            "ous": {
                "selected": [
                    20000909435000,
                    20000909435030,
                    20000909435004
                ],
                "unselected": [
                    20000909435900,
                    20000082399090
                ],
                "exclude_child_ou": false
            }
        },
        "period": {
            "days": 30,
            "range": "last7Days",
            "start_date": "31/3/2025 06:30:00 PM",
            "end_date": "1/4/2025 06:30:00 PM"
        },
        "duration": {
            "days": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Friday",
                "Saturday"
            ],
            "from": "4",
            "to": 24
        },
        "group_type": "global",
        "group_scope": "universal",
        "attribute": "samAccountName",
        "matching_criteria": "matchAll",
        "photo_based_selected": {
            "user_based_photo": "userWithPhoto",
            "user_based_photo_attribute": "photo"
        },
        "logon_permission": "permittedHours",
        "top": 7,
        "exclude_disabled_users": true,
        "never_logged_on_users": true,
        "account_expired_users": true,
        "based_on": "lastLogonTime",
        "groups": [
            "2000000153382",
            "2000000153332"
        ],
        "exclude_nested_groups": false,
        "users": [
            "2000000152382",
            "2000000153332"
        ],
        "attributes": [
            "2000000152382",
            "2000000153332"
        ],
        "os": [
            "2000000100069",
            "2000000099143"
        ],
        "policies": [
            "2000000152382",
            "2000000153332"
        ]
    },
    "view_columns": [
        "mail",
        "sAMAccountName",
        "memberOfLocation",
        "memberOf",
        "name",
        "distinguishedName",
        "createdOn"
    ],
    "criteria_filter": {
        "rows": [
            {
                "appId": "2000000021027",
                "field_id": "2000000093880",
                "display_name": "Object ID",
                "operator_id": "2000000092917",
                "operator_display_name": "Starts With",
                "logic_operator": "AND",
                "logic_operator_display_name": "wsmclient.criteria.logic_operator.and",
                "rowType": "row",
                "type": "2000000092896",
                "value_component_id": "CRITERIA_TEXT_FIELD",
                "value_object": "one"
            },
            {
                "appId": "2000000021027",
                "field_id": "2000000093880",
                "display_name": "Object ID",
                "operator_id": "2000000092917",
                "operator_display_name": "Starts With",
                "logic_operator": "OR",
                "logic_operator_display_name": "wsmclient.criteria.logic_operator.or",
                "rowType": "row",
                "type": "2000000092896",
                "value_component_id": "CRITERIA_TEXT_FIELD",
                "value_object": "two"
            },
            {
                "appId": "2000000021027",
                "field_id": "2000000093880",
                "display_name": "Object ID",
                "operator_id": "2000000092917",
                "operator_display_name": "Starts With",
                "logic_operator": "AND",
                "logic_operator_display_name": "wsmclient.criteria.logic_operator.and",
                "rowType": "row",
                "type": "2000000092896",
                "value_component_id": "CRITERIA_TEXT_FIELD",
                "value_object": "three"
            }
        ],
        "pattern": "( 1 OR  2 AND  3 )"
    }
}

Get Report Details

Used to get the previously saved report input data, view columns, and criteria for a specific report.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-ZCSRF-TOKEN", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/2000000000001"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/2000000000001")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-ZCSRF-TOKEN", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {Accept: 'application/json', 'X-ZCSRF-TOKEN': 'REPLACE_KEY_VALUE'}
};

fetch('https://id360.manageengine.com/api/v1/reports/2000000000001', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'X-ZCSRF-TOKEN': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v1/reports/2000000000001", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/2000000000001",
  "headers": {
    "Accept": "application/json",
    "X-ZCSRF-TOKEN": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/reports/2000000000001 \
  --header 'Accept: application/json' \
  --header 'X-ZCSRF-TOKEN: REPLACE_KEY_VALUE'

{
    "data": {
        "inputs": {
            "domains": [
                {
                    "id": "200090909090",
                    "ous": {
                        "selected": [
                            20000909435000,
                            20000909435030,
                            20000909435004
                        ],
                        "unselected": [
                            20000909435900,
                            20000082399090
                        ],
                        "exclude_child_ou": false
                    }
                }
            ],
            "domain": {
                "id": "200090909090",
                "ous": {
                    "selected": [
                        20000909435000,
                        20000909435030,
                        20000909435004
                    ],
                    "unselected": [
                        20000909435900,
                        20000082399090
                    ],
                    "exclude_child_ou": false
                }
            },
            "period": {
                "days": 30,
                "range": "last7Days",
                "start_date": "31/3/2025 06:30:00 PM",
                "end_date": "1/4/2025 06:30:00 PM"
            },
            "duration": {
                "days": [
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                    "Saturday"
                ],
                "from": "4",
                "to": 24
            },
            "group_type": "global",
            "group_scope": "universal",
            "attribute": "samAccountName",
            "matching_criteria": "matchAll",
            "photo_based_selected": {
                "user_based_photo": "userWithPhoto",
                "user_based_photo_attribute": "photo"
            },
            "logon_permission": "permittedHours",
            "top": 7,
            "exclude_disabled_users": true,
            "never_logged_on_users": true,
            "account_expired_users": true,
            "based_on": "lastLogonTime",
            "groups": [
                "2000000153382",
                "2000000153332"
            ],
            "exclude_nested_groups": false,
            "users": [
                "2000000152382",
                "2000000153332"
            ],
            "attributes": [
                "2000000152382",
                "2000000153332"
            ],
            "os": [
                "2000000100069",
                "2000000099143"
            ],
            "policies": [
                "2000000152382",
                "2000000153332"
            ]
        },
        "view_columns": [
            "mail",
            "sAMAccountName",
            "memberOfLocation",
            "memberOf",
            "name",
            "distinguishedName",
            "createdOn"
        ],
        "criteria_filter": {
            "rows": [
                {
                    "appId": "2000000021027",
                    "field_id": "2000000093880",
                    "display_name": "Object ID",
                    "operator_id": "2000000092917",
                    "operator_display_name": "Starts With",
                    "logic_operator": "AND",
                    "logic_operator_display_name": "wsmclient.criteria.logic_operator.and",
                    "rowType": "row",
                    "type": "2000000092896",
                    "value_component_id": "CRITERIA_TEXT_FIELD",
                    "value_object": "one"
                },
                {
                    "appId": "2000000021027",
                    "field_id": "2000000093880",
                    "display_name": "Object ID",
                    "operator_id": "2000000092917",
                    "operator_display_name": "Starts With",
                    "logic_operator": "OR",
                    "logic_operator_display_name": "wsmclient.criteria.logic_operator.or",
                    "rowType": "row",
                    "type": "2000000092896",
                    "value_component_id": "CRITERIA_TEXT_FIELD",
                    "value_object": "two"
                },
                {
                    "appId": "2000000021027",
                    "field_id": "2000000093880",
                    "display_name": "Object ID",
                    "operator_id": "2000000092917",
                    "operator_display_name": "Starts With",
                    "logic_operator": "AND",
                    "logic_operator_display_name": "wsmclient.criteria.logic_operator.and",
                    "rowType": "row",
                    "type": "2000000092896",
                    "value_component_id": "CRITERIA_TEXT_FIELD",
                    "value_object": "three"
                }
            ],
            "pattern": "( 1 OR  2 AND  3 )"
        }
    }
}

{
    "error_code": "INVALID_PARAMETER",
    "message": "Invalid parameter value provided."
}

{
    "error_code": "UNAUTHORIZED",
    "message": "Authentication required or failed."
}

{
    "error_code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred."
}

Update report details

To update criteria, view columns and inputs for a report

Arguments

inputs

object

Show Sub-Attributes

domains

array

Show Sub-Attributes

string

Domain ID

ous

object

Object to specify selected and unselected OUs

Show Sub-Attributes

selected

array

List of selected OUs ID

unselected

array

List of unselected OUs ID

exclude_child_ou

boolean

A flag to specify exclusion of child OUs

domain

object

Show Sub-Attributes

string

Domain ID

ous

object

Object to specify selected and unselected OUs

Show Sub-Attributes

selected

array

List of selected OUs ID

unselected

array

List of unselected OUs ID

exclude_child_ou

boolean

A flag to specify exclusion of child OUs

period

object

No of days input - used in date based reports

Show Sub-Attributes

days

integer

No of days

range

string

Range of days

start_date

string

Start date of range

end_date

string

End date of range

duration

object

Used in logon hours report

Show Sub-Attributes

days

array

Array of days

from

string

selected value in hour

string

selected value in hour

group_type

string

Used in group type and scope reports.

Allowed Values:

distribution
security

group_scope

string

Used in group type and scope reports

Allowed Values:

global
domain_local
universal

attribute

string

Used in attribute based reports

matching_criteria

string

Matching criteria for attribute based reports

Allowed Values:

matchAll
matchAny

photo_based_selected

object

Used in photo based reports

Show Sub-Attributes

user_based_photo

string

Used in photo based reports to specify user based photo

Allowed Values:

userWithPhoto
userWithOutPhoto

user_based_photo_attribute

string

Used in photo based reports to specify user based photo attribute

Allowed Values:

thumbnailPhoto
thumbnailLogo
photo

logon_permission

string

Used in logon hour based reports

top

integer

Used in Top N Big groups

exclude_disabled_users

boolean

Used in reports having advanced filter dropdown checkbox

never_logged_on_users

boolean

Used in reports having advanced filter dropdown checkbox

account_expired_users

boolean

Used in reports having advanced filter dropdown checkbox

based_on

string

Used in reports having advanced filter dropdown checkbox

groups

array

Used in popup input based reports for groups

exclude_nested_groups

boolean

Used in reports having advanced filter dropdown checkbox

users

array

Array of user IDs for manager report, array of manager user IDs.

attributes

array

Used in popup input based reports based on attribute IDs

array

Array of OS Ids for OS based reports

policies

array

Array of policy Ids for policy based reports

view_columns

array

List of columns to be displayed in the report view.

criteria_filter

object

Show Sub-Attributes

rows

array

Show Sub-Attributes

appId

string

The application ID associated with the criteria.

field_id

string

The ID of the field being filtered.

display_name

string

The display name of the field.

operator_id

string

The ID of the operator used for filtering.

operator_display_name

string

The display name of the operator.

logic_operator

string

The logical operator used in the criteria (e.g., AND, OR).

logic_operator_display_name

string

The display name of the logical operator.

rowType

string

Type of row, e.g., 'row'.

type

string

Type of criteria, e.g., '2000000092896'.

value_component_id

string

Component ID for the value input.

value_object

string

The value associated with the criteria.

pattern

string

A string representation of the logical structure of the criteria.

Request Example

parameters_data='{"inputs":{"domains":[{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}}],"domain":{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}},"period":{"days":30,"range":"last7Days","start_date":"31/3/2025 06:30:00 PM","end_date":"1/4/2025 06:30:00 PM"},"duration":{"days":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"from":"4","to":24},"group_type":"global","group_scope":"universal","attribute":"samAccountName","matching_criteria":"matchAll","photo_based_selected":{"user_based_photo":"userWithPhoto","user_based_photo_attribute":"photo"},"logon_permission":"permittedHours","top":7,"exclude_disabled_users":true,"never_logged_on_users":true,"account_expired_users":true,"based_on":"lastLogonTime","groups":["2000000153382","2000000153332"],"exclude_nested_groups":false,"users":["2000000152382","2000000153332"],"attributes":["2000000152382","2000000153332"],"os":["2000000100069","2000000099143"],"policies":["2000000152382","2000000153332"]},"view_columns":["mail","sAMAccountName","memberOfLocation","memberOf","name","distinguishedName","createdOn"],"criteria_filter":{"rows":[{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"AND","logic_operator_display_name":"wsmclient.criteria.logic_operator.and","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"one"},{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"OR","logic_operator_display_name":"wsmclient.criteria.logic_operator.or","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"two"},{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"AND","logic_operator_display_name":"wsmclient.criteria.logic_operator.and","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"three"}],"pattern":"( 1 OR  2 AND  3 )"}}';
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/12345"
type: PATCH
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"inputs\":{\"domains\":[{\"id\":\"200090909090\",\"ous\":{\"selected\":[20000909435000,20000909435030,20000909435004],\"unselected\":[20000909435900,20000082399090],\"exclude_child_ou\":false}}],\"domain\":{\"id\":\"200090909090\",\"ous\":{\"selected\":[20000909435000,20000909435030,20000909435004],\"unselected\":[20000909435900,20000082399090],\"exclude_child_ou\":false}},\"period\":{\"days\":30,\"range\":\"last7Days\",\"start_date\":\"31/3/2025 06:30:00 PM\",\"end_date\":\"1/4/2025 06:30:00 PM\"},\"duration\":{\"days\":[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"],\"from\":\"4\",\"to\":24},\"group_type\":\"global\",\"group_scope\":\"universal\",\"attribute\":\"samAccountName\",\"matching_criteria\":\"matchAll\",\"photo_based_selected\":{\"user_based_photo\":\"userWithPhoto\",\"user_based_photo_attribute\":\"photo\"},\"logon_permission\":\"permittedHours\",\"top\":7,\"exclude_disabled_users\":true,\"never_logged_on_users\":true,\"account_expired_users\":true,\"based_on\":\"lastLogonTime\",\"groups\":[\"2000000153382\",\"2000000153332\"],\"exclude_nested_groups\":false,\"users\":[\"2000000152382\",\"2000000153332\"],\"attributes\":[\"2000000152382\",\"2000000153332\"],\"os\":[\"2000000100069\",\"2000000099143\"],\"policies\":[\"2000000152382\",\"2000000153332\"]},\"view_columns\":[\"mail\",\"sAMAccountName\",\"memberOfLocation\",\"memberOf\",\"name\",\"distinguishedName\",\"createdOn\"],\"criteria_filter\":{\"rows\":[{\"appId\":\"2000000021027\",\"field_id\":\"2000000093880\",\"display_name\":\"Object ID\",\"operator_id\":\"2000000092917\",\"operator_display_name\":\"Starts With\",\"logic_operator\":\"AND\",\"logic_operator_display_name\":\"wsmclient.criteria.logic_operator.and\",\"rowType\":\"row\",\"type\":\"2000000092896\",\"value_component_id\":\"CRITERIA_TEXT_FIELD\",\"value_object\":\"one\"},{\"appId\":\"2000000021027\",\"field_id\":\"2000000093880\",\"display_name\":\"Object ID\",\"operator_id\":\"2000000092917\",\"operator_display_name\":\"Starts With\",\"logic_operator\":\"OR\",\"logic_operator_display_name\":\"wsmclient.criteria.logic_operator.or\",\"rowType\":\"row\",\"type\":\"2000000092896\",\"value_component_id\":\"CRITERIA_TEXT_FIELD\",\"value_object\":\"two\"},{\"appId\":\"2000000021027\",\"field_id\":\"2000000093880\",\"display_name\":\"Object ID\",\"operator_id\":\"2000000092917\",\"operator_display_name\":\"Starts With\",\"logic_operator\":\"AND\",\"logic_operator_display_name\":\"wsmclient.criteria.logic_operator.and\",\"rowType\":\"row\",\"type\":\"2000000092896\",\"value_component_id\":\"CRITERIA_TEXT_FIELD\",\"value_object\":\"three\"}],\"pattern\":\"( 1 OR  2 AND  3 )\"}}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/12345")
  .patch(body)
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PATCH',
  headers: {'content-type': 'application/json'},
  body: '{"inputs":{"domains":[{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}}],"domain":{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}},"period":{"days":30,"range":"last7Days","start_date":"31/3/2025 06:30:00 PM","end_date":"1/4/2025 06:30:00 PM"},"duration":{"days":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"from":"4","to":24},"group_type":"global","group_scope":"universal","attribute":"samAccountName","matching_criteria":"matchAll","photo_based_selected":{"user_based_photo":"userWithPhoto","user_based_photo_attribute":"photo"},"logon_permission":"permittedHours","top":7,"exclude_disabled_users":true,"never_logged_on_users":true,"account_expired_users":true,"based_on":"lastLogonTime","groups":["2000000153382","2000000153332"],"exclude_nested_groups":false,"users":["2000000152382","2000000153332"],"attributes":["2000000152382","2000000153332"],"os":["2000000100069","2000000099143"],"policies":["2000000152382","2000000153332"]},"view_columns":["mail","sAMAccountName","memberOfLocation","memberOf","name","distinguishedName","createdOn"],"criteria_filter":{"rows":[{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"AND","logic_operator_display_name":"wsmclient.criteria.logic_operator.and","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"one"},{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"OR","logic_operator_display_name":"wsmclient.criteria.logic_operator.or","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"two"},{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"AND","logic_operator_display_name":"wsmclient.criteria.logic_operator.and","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"three"}],"pattern":"( 1 OR  2 AND  3 )"}}'
};

fetch('https://id360.manageengine.com/api/v1/reports/12345', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"inputs\":{\"domains\":[{\"id\":\"200090909090\",\"ous\":{\"selected\":[20000909435000,20000909435030,20000909435004],\"unselected\":[20000909435900,20000082399090],\"exclude_child_ou\":false}}],\"domain\":{\"id\":\"200090909090\",\"ous\":{\"selected\":[20000909435000,20000909435030,20000909435004],\"unselected\":[20000909435900,20000082399090],\"exclude_child_ou\":false}},\"period\":{\"days\":30,\"range\":\"last7Days\",\"start_date\":\"31/3/2025 06:30:00 PM\",\"end_date\":\"1/4/2025 06:30:00 PM\"},\"duration\":{\"days\":[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"],\"from\":\"4\",\"to\":24},\"group_type\":\"global\",\"group_scope\":\"universal\",\"attribute\":\"samAccountName\",\"matching_criteria\":\"matchAll\",\"photo_based_selected\":{\"user_based_photo\":\"userWithPhoto\",\"user_based_photo_attribute\":\"photo\"},\"logon_permission\":\"permittedHours\",\"top\":7,\"exclude_disabled_users\":true,\"never_logged_on_users\":true,\"account_expired_users\":true,\"based_on\":\"lastLogonTime\",\"groups\":[\"2000000153382\",\"2000000153332\"],\"exclude_nested_groups\":false,\"users\":[\"2000000152382\",\"2000000153332\"],\"attributes\":[\"2000000152382\",\"2000000153332\"],\"os\":[\"2000000100069\",\"2000000099143\"],\"policies\":[\"2000000152382\",\"2000000153332\"]},\"view_columns\":[\"mail\",\"sAMAccountName\",\"memberOfLocation\",\"memberOf\",\"name\",\"distinguishedName\",\"createdOn\"],\"criteria_filter\":{\"rows\":[{\"appId\":\"2000000021027\",\"field_id\":\"2000000093880\",\"display_name\":\"Object ID\",\"operator_id\":\"2000000092917\",\"operator_display_name\":\"Starts With\",\"logic_operator\":\"AND\",\"logic_operator_display_name\":\"wsmclient.criteria.logic_operator.and\",\"rowType\":\"row\",\"type\":\"2000000092896\",\"value_component_id\":\"CRITERIA_TEXT_FIELD\",\"value_object\":\"one\"},{\"appId\":\"2000000021027\",\"field_id\":\"2000000093880\",\"display_name\":\"Object ID\",\"operator_id\":\"2000000092917\",\"operator_display_name\":\"Starts With\",\"logic_operator\":\"OR\",\"logic_operator_display_name\":\"wsmclient.criteria.logic_operator.or\",\"rowType\":\"row\",\"type\":\"2000000092896\",\"value_component_id\":\"CRITERIA_TEXT_FIELD\",\"value_object\":\"two\"},{\"appId\":\"2000000021027\",\"field_id\":\"2000000093880\",\"display_name\":\"Object ID\",\"operator_id\":\"2000000092917\",\"operator_display_name\":\"Starts With\",\"logic_operator\":\"AND\",\"logic_operator_display_name\":\"wsmclient.criteria.logic_operator.and\",\"rowType\":\"row\",\"type\":\"2000000092896\",\"value_component_id\":\"CRITERIA_TEXT_FIELD\",\"value_object\":\"three\"}],\"pattern\":\"( 1 OR  2 AND  3 )\"}}"

headers = { 'content-type': "application/json" }

conn.request("PATCH", "/api/v1/reports/12345", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PATCH",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/12345",
  "headers": {
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  inputs: {
    domains: [
      {
        id: '200090909090',
        ous: {
          selected: [20000909435000, 20000909435030, 20000909435004],
          unselected: [20000909435900, 20000082399090],
          exclude_child_ou: false
        }
      }
    ],
    domain: {
      id: '200090909090',
      ous: {
        selected: [20000909435000, 20000909435030, 20000909435004],
        unselected: [20000909435900, 20000082399090],
        exclude_child_ou: false
      }
    },
    period: {
      days: 30,
      range: 'last7Days',
      start_date: '31/3/2025 06:30:00 PM',
      end_date: '1/4/2025 06:30:00 PM'
    },
    duration: {
      days: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
      from: '4',
      to: 24
    },
    group_type: 'global',
    group_scope: 'universal',
    attribute: 'samAccountName',
    matching_criteria: 'matchAll',
    photo_based_selected: {user_based_photo: 'userWithPhoto', user_based_photo_attribute: 'photo'},
    logon_permission: 'permittedHours',
    top: 7,
    exclude_disabled_users: true,
    never_logged_on_users: true,
    account_expired_users: true,
    based_on: 'lastLogonTime',
    groups: ['2000000153382', '2000000153332'],
    exclude_nested_groups: false,
    users: ['2000000152382', '2000000153332'],
    attributes: ['2000000152382', '2000000153332'],
    os: ['2000000100069', '2000000099143'],
    policies: ['2000000152382', '2000000153332']
  },
  view_columns: [
    'mail',
    'sAMAccountName',
    'memberOfLocation',
    'memberOf',
    'name',
    'distinguishedName',
    'createdOn'
  ],
  criteria_filter: {
    rows: [
      {
        appId: '2000000021027',
        field_id: '2000000093880',
        display_name: 'Object ID',
        operator_id: '2000000092917',
        operator_display_name: 'Starts With',
        logic_operator: 'AND',
        logic_operator_display_name: 'wsmclient.criteria.logic_operator.and',
        rowType: 'row',
        type: '2000000092896',
        value_component_id: 'CRITERIA_TEXT_FIELD',
        value_object: 'one'
      },
      {
        appId: '2000000021027',
        field_id: '2000000093880',
        display_name: 'Object ID',
        operator_id: '2000000092917',
        operator_display_name: 'Starts With',
        logic_operator: 'OR',
        logic_operator_display_name: 'wsmclient.criteria.logic_operator.or',
        rowType: 'row',
        type: '2000000092896',
        value_component_id: 'CRITERIA_TEXT_FIELD',
        value_object: 'two'
      },
      {
        appId: '2000000021027',
        field_id: '2000000093880',
        display_name: 'Object ID',
        operator_id: '2000000092917',
        operator_display_name: 'Starts With',
        logic_operator: 'AND',
        logic_operator_display_name: 'wsmclient.criteria.logic_operator.and',
        rowType: 'row',
        type: '2000000092896',
        value_component_id: 'CRITERIA_TEXT_FIELD',
        value_object: 'three'
      }
    ],
    pattern: '( 1 OR  2 AND  3 )'
  }
}));
req.end();

curl --request PATCH \
  --url https://id360.manageengine.com/api/v1/reports/12345 \
  --header 'content-type: application/json' \
  --data '{"inputs":{"domains":[{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}}],"domain":{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}},"period":{"days":30,"range":"last7Days","start_date":"31/3/2025 06:30:00 PM","end_date":"1/4/2025 06:30:00 PM"},"duration":{"days":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"from":"4","to":24},"group_type":"global","group_scope":"universal","attribute":"samAccountName","matching_criteria":"matchAll","photo_based_selected":{"user_based_photo":"userWithPhoto","user_based_photo_attribute":"photo"},"logon_permission":"permittedHours","top":7,"exclude_disabled_users":true,"never_logged_on_users":true,"account_expired_users":true,"based_on":"lastLogonTime","groups":["2000000153382","2000000153332"],"exclude_nested_groups":false,"users":["2000000152382","2000000153332"],"attributes":["2000000152382","2000000153332"],"os":["2000000100069","2000000099143"],"policies":["2000000152382","2000000153332"]},"view_columns":["mail","sAMAccountName","memberOfLocation","memberOf","name","distinguishedName","createdOn"],"criteria_filter":{"rows":[{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"AND","logic_operator_display_name":"wsmclient.criteria.logic_operator.and","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"one"},{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"OR","logic_operator_display_name":"wsmclient.criteria.logic_operator.or","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"two"},{"appId":"2000000021027","field_id":"2000000093880","display_name":"Object ID","operator_id":"2000000092917","operator_display_name":"Starts With","logic_operator":"AND","logic_operator_display_name":"wsmclient.criteria.logic_operator.and","rowType":"row","type":"2000000092896","value_component_id":"CRITERIA_TEXT_FIELD","value_object":"three"}],"pattern":"( 1 OR  2 AND  3 )"}}'

{
    "inputs": {
        "domains": [
            {
                "id": "200090909090",
                "ous": {
                    "selected": [
                        20000909435000,
                        20000909435030,
                        20000909435004
                    ],
                    "unselected": [
                        20000909435900,
                        20000082399090
                    ],
                    "exclude_child_ou": false
                }
            }
        ],
        "domain": {
            "id": "200090909090",
            "ous": {
                "selected": [
                    20000909435000,
                    20000909435030,
                    20000909435004
                ],
                "unselected": [
                    20000909435900,
                    20000082399090
                ],
                "exclude_child_ou": false
            }
        },
        "period": {
            "days": 30,
            "range": "last7Days",
            "start_date": "31/3/2025 06:30:00 PM",
            "end_date": "1/4/2025 06:30:00 PM"
        },
        "duration": {
            "days": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Friday",
                "Saturday"
            ],
            "from": "4",
            "to": 24
        },
        "group_type": "global",
        "group_scope": "universal",
        "attribute": "samAccountName",
        "matching_criteria": "matchAll",
        "photo_based_selected": {
            "user_based_photo": "userWithPhoto",
            "user_based_photo_attribute": "photo"
        },
        "logon_permission": "permittedHours",
        "top": 7,
        "exclude_disabled_users": true,
        "never_logged_on_users": true,
        "account_expired_users": true,
        "based_on": "lastLogonTime",
        "groups": [
            "2000000153382",
            "2000000153332"
        ],
        "exclude_nested_groups": false,
        "users": [
            "2000000152382",
            "2000000153332"
        ],
        "attributes": [
            "2000000152382",
            "2000000153332"
        ],
        "os": [
            "2000000100069",
            "2000000099143"
        ],
        "policies": [
            "2000000152382",
            "2000000153332"
        ]
    },
    "view_columns": [
        "mail",
        "sAMAccountName",
        "memberOfLocation",
        "memberOf",
        "name",
        "distinguishedName",
        "createdOn"
    ],
    "criteria_filter": {
        "rows": [
            {
                "appId": "2000000021027",
                "field_id": "2000000093880",
                "display_name": "Object ID",
                "operator_id": "2000000092917",
                "operator_display_name": "Starts With",
                "logic_operator": "AND",
                "logic_operator_display_name": "wsmclient.criteria.logic_operator.and",
                "rowType": "row",
                "type": "2000000092896",
                "value_component_id": "CRITERIA_TEXT_FIELD",
                "value_object": "one"
            },
            {
                "appId": "2000000021027",
                "field_id": "2000000093880",
                "display_name": "Object ID",
                "operator_id": "2000000092917",
                "operator_display_name": "Starts With",
                "logic_operator": "OR",
                "logic_operator_display_name": "wsmclient.criteria.logic_operator.or",
                "rowType": "row",
                "type": "2000000092896",
                "value_component_id": "CRITERIA_TEXT_FIELD",
                "value_object": "two"
            },
            {
                "appId": "2000000021027",
                "field_id": "2000000093880",
                "display_name": "Object ID",
                "operator_id": "2000000092917",
                "operator_display_name": "Starts With",
                "logic_operator": "AND",
                "logic_operator_display_name": "wsmclient.criteria.logic_operator.and",
                "rowType": "row",
                "type": "2000000092896",
                "value_component_id": "CRITERIA_TEXT_FIELD",
                "value_object": "three"
            }
        ],
        "pattern": "( 1 OR  2 AND  3 )"
    }
}

{
    "data": {
        "id": "2000000293042",
        "status": "RUNNING",
        "message": "Process is initiated, check jobs for current status."
    },
    "links": {
        "status": {
            "href": "/jobs/2000000293042"
        }
    }
}

Retrieve Report Data

Retrieves data for a specific report, allowing for sorting, filtering, pagination, and view selection.

Query Parameters

sort

Sort order for the results. Prepend with '-' for descending order.

filter

Filter criteria for the results.

from

The starting index of the results to return.

limit

The maximum number of results to return.

view

The view type for the report data.

Request Example

response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/12345/data"
type: GET
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/12345/data")
  .get()
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'GET'};

fetch('https://id360.manageengine.com/api/v1/reports/12345/data', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

conn.request("GET", "/api/v1/reports/12345/data")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/12345/data",
  "headers": {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/reports/12345/data

{
    "data": [
        {
            "mail": "#$&!#@erpdev19.com",
            "sAMAccountName": "#$&!#-11789910591",
            "memberOfLocation": "NestedGroup[distgrps]",
            "memberOf": "NestedGroup",
            "name": "#$&!#",
            "distinguishedName": "CN=\\#$&!\\#,CN=Users,DC=erpdev19,DC=com",
            "createdOn": "2023/04/05 08:23:02"
        },
        {
            "mail": "ChildOuUser1@erpdev19.com",
            "sAMAccountName": "ChildOuUser1",
            "memberOfLocation": "Domain Users[Users]; Group_4f608f75-fd79-4962-b9ef-5057b4ffd535[distgrps]; mytestgroup[Users]; NestedGroup[distgrps]",
            "memberOf": "Domain Users; Group_4f608f75-fd79-4962-b9ef-5057b4ffd535; mytestgroup; NestedGroup",
            "name": "ChildOuUser1",
            "distinguishedName": "CN=ChildOuUser1,OU=ChildOU,OU=ParentOU,DC=erpdev19,DC=com",
            "createdOn": "2024/09/03 17:56:24"
        },
        {
            "mail": "conference@erpdev19.com",
            "sAMAccountName": "conference",
            "memberOfLocation": "Domain Users[Users]; mytestgroup[Users]; NestedGroup[distgrps]",
            "memberOf": "Domain Users; mytestgroup; NestedGroup",
            "name": "Conference",
            "distinguishedName": "CN=Conference,CN=Users,DC=erpdev19,DC=com",
            "createdOn": "2023/08/03 04:08:20"
        },
        {
            "mail": "Create@erpdev19.com",
            "sAMAccountName": "Create",
            "memberOfLocation": "Domain Users[Users]; NestedGroup[distgrps]",
            "memberOf": "Domain Users; NestedGroup",
            "name": "Create",
            "distinguishedName": "CN=Create,CN=Users,DC=erpdev19,DC=com",
            "createdOn": "2023/03/30 05:38:36"
        },
        {
            "mail": "dev@erpdev19.com",
            "sAMAccountName": "dev",
            "memberOfLocation": "Ad created secuirty grp[distgrps]; Administrators[Builtin]; Compliance Management[Microsoft Exchange Security Groups]; dg10[distgrps]; DG_1[DG]; DG_10[DG]; DG_100[DG]; DG_1000[DG]; DG_101[DG]; DG_102[DG]; DG_103[DG]; DG_104[DG]; DG_105[DG]; DG_106[DG]; DG_107[DG]; DG_108[DG]; DG_109[DG]; DG_11[DG]; DG_110[DG]; DG_111[DG]; DG_112[DG]; DG_113[DG]; DG_114[DG]; DG_115[DG]; DG_116[DG]; DG_117[DG]; DG_118[DG]; DG_119[DG]; DG_12[DG]; DG_120[DG]; DG_121[DG]; DG_122[DG]; DG_123[DG]; DG_124[DG]; DG_125[DG]; DG_126[DG]; DG_127[DG]; DG_128[DG]; DG_129[DG]; DG_13[DG]; DG_130[DG]; DG_131[DG]; DG_132[DG]; DG_133[DG]; DG_134[DG]; DG_135[DG]; DG_136[DG]; DG_137[DG]; DG_138[DG]; DG_139[DG]; DG_14[DG]; DG_140[DG]; DG_141[DG]; DG_142[DG]; DG_143[DG]; DG_144[DG]; DG_145[DG]; DG_146[DG]; DG_147[DG]; DG_148[DG]; DG_149[DG]; DG_15[DG]; DG_150[DG]; DG_151[DG]; DG_152[DG]; DG_153[DG]; DG_154[DG]; DG_155[DG]; DG_156[DG]; DG_157[DG]; DG_158[DG]; DG_159[DG]; DG_16[DG]; DG_160[DG]; DG_161[DG]; DG_162[DG]; DG_163[DG]; DG_164[DG]; DG_165[DG]",
            "memberOf": "Ad created secuirty grp; Administrators; Compliance Management; dg10; DG_1; DG_10; DG_100; DG_1000; DG_101; DG_102; DG_103; DG_104; DG_105; DG_106; DG_107; DG_108; DG_109; DG_11; DG_110; DG_111; DG_112; DG_113; DG_114; DG_115; DG_116; DG_117; DG_118; DG_119; DG_12; DG_120; DG_121; DG_122; DG_123; DG_124; DG_125; DG_126; DG_127; DG_128; DG_129; DG_13; DG_130; DG_131; DG_132; DG_133; DG_134; DG_135; DG_136; DG_137; DG_138; DG_139; DG_14; DG_140; DG_141; DG_142; DG_143; DG_144; DG_145; DG_146; DG_147; DG_148; DG_149; DG_15; DG_150; DG_151; DG_152; DG_153; DG_154; DG_155; DG_156; DG_157; DG_158; DG_159; DG_16; DG_160; DG_161; DG_162; DG_163; DG_164; DG_165; DG_166; DG_167; DG_168; DG_169; DG_17; DG_170; DG_171; DG_172; DG_173; DG_174; DG_175; DG_176; DG_177; DG_178; DG_179; DG_18; DG_180; DG_181; DG_182; DG_183; DG_184; DG_185; DG_186; DG_187; DG_188; DG_189; DG_19; DG_190; DG_191; DG_192; DG_193; DG_194; DG_195; DG_196; DG_197; DG_198; DG_199; DG_2; DG_20; DG_200; DG_201; DG_202; DG_203; DG_204; DG_205; DG_206;",
            "name": "dev",
            "distinguishedName": "CN=dev,CN=Users,DC=erpdev19,DC=com",
            "createdOn": "2023/10/27 03:30:12"
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 50,
        "total_no_of_objects": 2
    }
}

Get total count - report table data

Retrieves the total number of objects for a specific report.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-ZCSRF-TOKEN", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/2000000000001/data/total-count"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/2000000000001/data/total-count")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-ZCSRF-TOKEN", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {Accept: 'application/json', 'X-ZCSRF-TOKEN': 'REPLACE_KEY_VALUE'}
};

fetch('https://id360.manageengine.com/api/v1/reports/2000000000001/data/total-count', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'X-ZCSRF-TOKEN': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v1/reports/2000000000001/data/total-count", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/2000000000001/data/total-count",
  "headers": {
    "Accept": "application/json",
    "X-ZCSRF-TOKEN": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/reports/2000000000001/data/total-count \
  --header 'Accept: application/json' \
  --header 'X-ZCSRF-TOKEN: REPLACE_KEY_VALUE'

{
    "total_no_of_objects": 310
}

{
    "error_code": "INVALID_PARAMETER",
    "message": "Invalid parameter value provided."
}

{
    "error_code": "UNAUTHORIZED",
    "message": "Authentication required or failed."
}

{
    "error_code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred."
}

Export Report

Exports data for a specific report based on provided filters and view, allowing selection of export type.

Arguments

format

string

Type of the export file

Query Parameters

sort

Sort order for the results to be exported. Prepend with '-' for descending order.

filter

Filter criteria for the results to be exported.

view

The view type for the report data to be exported.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/12345/export"
type: POST
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/12345/export")
  .post(body)
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {'content-type': 'application/json'},
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://id360.manageengine.com/api/v1/reports/12345/export', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = { 'content-type': "application/json" }

conn.request("POST", "/api/v1/reports/12345/export", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/12345/export",
  "headers": {
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url https://id360.manageengine.com/api/v1/reports/12345/export \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "format": "csv"
}

{
    "data": {
        "id": "2000000293042",
        "status": "RUNNING",
        "message": "Process is initiated, check jobs for current status."
    },
    "links": {
        "status": {
            "href": "/jobs/2000000293042"
        }
    }
}

Get Export Settings

Retrieves the current export settings for a specific report.

Request Example

response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/12345/export_settings"
type: GET
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/12345/export_settings")
  .get()
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'GET'};

fetch('https://id360.manageengine.com/api/v1/reports/12345/export_settings', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

conn.request("GET", "/api/v1/reports/12345/export_settings")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/12345/export_settings",
  "headers": {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/reports/12345/export_settings

{
    "data": {
        "file_name": "file name",
        "description": "description",
        "include_logo_in_header": true,
        "show_logo_on_first_page_only": true,
        "show_hyphen_for_empty_values": true,
        "include_serial_number_column": true
    }
}

Modify Export Settings

Updates the export settings for a specific report.

Arguments

file_name

string

The default file name for the exported report.

description

string

A description for the export settings.

include_logo_in_header

boolean

Indicates whether the logo should be included in the report header.

show_logo_on_first_page_only

boolean

Indicates whether the logo should appear only on the first page.

show_hyphen_for_empty_values

boolean

Indicates whether a hyphen should be shown for empty values in the report.

include_serial_number_column

boolean

Indicates whether a serial number column should be included in the report.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/12345/export_settings"
type: PUT
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/12345/export_settings")
  .put(body)
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {'content-type': 'application/json'},
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://id360.manageengine.com/api/v1/reports/12345/export_settings', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = { 'content-type': "application/json" }

conn.request("PUT", "/api/v1/reports/12345/export_settings", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/12345/export_settings",
  "headers": {
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url https://id360.manageengine.com/api/v1/reports/12345/export_settings \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "file_name": "file name",
    "description": "description",
    "include_logo_in_header": true,
    "show_logo_on_first_page_only": true,
    "show_hyphen_for_empty_values": true,
    "include_serial_number_column": true
}

{
    "data": {
        "file_name": "file name",
        "description": "description",
        "include_logo_in_header": true,
        "show_logo_on_first_page_only": true,
        "show_hyphen_for_empty_values": true,
        "include_serial_number_column": true
    }
}

Direct Send Email

Sends a report via email based on specified filters, view, and email template.

Query Parameters

sort

Sort order for the report data. Prepend with '-' for descending order.

filter

Filter criteria for the report data.

view

The view type for the report data.

templateId

(Required)

The ID of the email template to use for sending the report.

Request Example

response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/reports/12345/send-email?templateId=2000000127109"
type: POST
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/reports/12345/send-email?templateId=2000000127109")
  .post(null)
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'POST'};

fetch('https://id360.manageengine.com/api/v1/reports/12345/send-email?templateId=2000000127109', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

conn.request("POST", "/api/v1/reports/12345/send-email?templateId=2000000127109")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/reports/12345/send-email?templateId=2000000127109",
  "headers": {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://id360.manageengine.com/api/v1/reports/12345/send-email?templateId=2000000127109'

{
    "data": {
        "id": "2000000293042",
        "status": "RUNNING",
        "message": "Process is initiated, check jobs for current status."
    },
    "links": {
        "status": {
            "href": "/jobs/2000000293042"
        }
    }
}