Skip To Content
ArcGIS Developers
Dashboard

/report: Reports

  • URL:https://[root]/community/users/[userName]/report
  • Version Introduced:ArcGIS Online December 2020

Example usage

Item: https://www.arcgis.com/sharing/rest/community/users/jsmith/report?f=pjson&reportType=org&reportSubType=content&token=
Member: https://www.arcgis.com/sharing/rest/community/users/jsmith/report?f=pjson&reportType=org&reportSubType=users&token=  
Credits: https://www.arcgis.com/sharing/rest/community/users/jsmith/report?f=json&reportType=org&reportSubType=credits&timeDuration=monthly&startTime=1589673600&token=
Activity: https://www.arcgis.com/sharing/rest/community/users/jsmith/report?f=json&reportType=org&reportSubType=activity&timeDuration=weekly&startTime=1589673600&token=

Description

The reports operation is to generate the reports of the overall usage of the organizations. Reports define organization usage metrics in one place for the day, week, or month. Administrators can monitor who is using which services, consuming how much credits and storage within certain time period. Reports also include current state of the organization such as number of items, groups, users, level 1s vs level 2s, App license assignments and public items.

Request parameters

ParameterDetails
[Common Parameters]

For a complete listing, see Common parameters.

f

The output format is JSON.

reportTypeorg
reportSubTypecontent|users|activity|credits

example: reportSubType=credits

timeDurationmonthly|weekly|daily

timeDuration is only required for

reportSubType=credits and reportSubType=activity

Daily is only available for reportSubType=activity.

startTime

Start time is noted in milliseconds.

Response properties

PropertyDetails
itemID

The ID of the newly created item (report).

status

The status of the item.

orgId

Organization ID.

owner

The owner of the item.

type

The type of the item.

Values: Administrative Report

created

The UNIX time stamp in milliseconds when the report was created.

properties

A JSON array of item properties; each item is detailed with properties described in the Request parameters section.

Example:

For item, and member reports

[
    "properties": {
        "reportType": "org",
        "reportSubType": "content"
    }
],
[
    "properties": {
        "reportType": "org",
        "reportSubType": "users"
    }
],

For credits, and activity reports

[
    "properties": {
        "timeDuration": "monthly",
        "startTime": 1593561600,
        "reportType": "org",
        "reportSubType": "credits"
    }
],
[
    "properties": {
        "timeDuration": "weekly",
        "startTime": 1589673600,
        "reportType": "org",
        "reportSubType": "activity"

    }
]

JSON Response syntax

{
    "itemId": "<item id>",
    "status": "processing",
    "orgId": "<org id>",
    "owner": "<owner>",
    "type": "Administrative Report",
    "created": <time in milliseconds>,
    "properties": {
        "reportType": "org",
        "reportSubType": content | users
    }
},
{
    "itemId": "<item id>",
    "status": "processing",
    "orgId": "<org id>",
    "owner": "<owner>",
    "type": "Administrative Report",
    "created": <time in milliseconds>,
    "properties": {
        "timeDuration": daily | weekly | monthly,
        "startTime": <startTime>,
        "reportType": "org",
        "reportSubType": credits | activity
    }
}

JSON Response example

{
  "itemId": "e45587025b1e4bf0b56044355f5a11d0",
  "status": "processing",
  "orgId": "J423vH8fR9HV444l",
  "owner": "jsmith",
  "type": "Administrative Report",
  "created": 1613148239000,
  "properties": {
    "reportType": "org",
    "reportSubType": "content"
  }
},

{
    "itemId": "1463c5a4f54041cda791cd1ff9fe0b1a",
    "status": "processing",
    "orgId": "J423vH8fR9HV444l",
    "owner": "jsmith",
    "type": "Administrative Report",
    "created": 1613148559000,
    "properties": {
        "timeDuration": "weekly",
        "startTime": 1589673600,
        "reportType": "org",
        "reportSubType": "activity"
    }
}