Reports (V1)

Reports (V1) API allows a user to get the types of reports available to them, the parameters of these reports, and a summary of all reports generated by the user. Users may also request new reports, download reports or delete reports. The types of reports a user may be able to request, download, or update depends on their permissions.

To request a report, see Report Management in the Getting Started section.

DELETE Reports

	DELETE /reportCenter/reports
Method	DELETE
URL or End Point	/v1/reportCenter/reports
Headers	Authorization, Content-Type
Query Parameters	reportIds
Body	Not applicable

This method deletes reports generated by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made to delete a specific report with reportId, ffb1cb2d-d123-1b42-beb1-1b234ce5678. The response returned showed that the report was successfully deleted.

curl -X
DEL
"https://api.equinix.com/v1/reportCenter/reports?reportIds=ffb1cb2d-d123-1b42-beb1-1b234ce5678"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name

Mandatory

Type

Example

Applicable Values

Description

reportIds

Yes

string

ffb1cb2d-d123-1b42-beb1-1b234ce5678

Identification (ID) number of the generated report.

Only reports that were successfully generated or encountered an error in the generation process may be deleted. Reports that are in progress (being generated) or delayed cannot be deleted.

Multiple report ID numbers should be comma-separated.

The maximum number of reports that can be deleted at a time is 20.

To get a list of all report ID numbers for reports that were successfully generated, refer to GET Reports under the API reference section.

[
  {
    "reportId": "ffb1cb2d-d123-1b42-beb1-1b234ce5678",
    "status": "SUCCESS"
  }
]

The description of the response payload is as follows:

Field name	Type	Example	Description
reportId	string		Report ID number.
status	string	SUCCESS	Status of deleted request. Status - Description SUCCESS - Report was successfully deleted. ERROR - There was an error and the report was not deleted.

If you get “Insufficient permissions” error, contact your Master Administrator.

DELETE Reports Scheduler

	DELETE /reportCenter/reports/scheduler
Method	DELETE
URL or End Point	/v1/reportCenter/reports/scheduler
Headers	Authorization, Content-Type
Query Parameters	reportIds
Body	Not applicable

This method deletes scheduled reports requested by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made to delete a specific scheduled report with scheduleId, ffb1cb2d-d123-1b42-beb1-1b234ce5678. The response returned showed that the report was successfully deleted.

curl -X
DEL "https://api.equinix.com/v1/reportCenter/reports/scheduler?scheduledIds=ffb1cb2d-d123-1b42-beb1-1b234ce5678"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name

Mandatory

Type

Example

Applicable Values

Description

scheduledIds

Yes

string

ffb1cb2d-d123-1b42-beb1-1b234ce5678

Identification (ID) number(s) of the scheduled report(s). Only scheduled reports that were successfully requested may be deleted.

Multiple scheduled ID numbers should be comma-separated.

The maximum number of scheduled reports that can be deleted at a time is 20.

If you are not sure of the scheduled ID, refer to GET Reports Scheduler under the API Reference section for more information.

{
  "status": true
}

The description of the response payload is as follows:

Field name	Type	Example	Description
status	string	true	Status of requested operation to delete the scheduled report(s). Status - Description true- Scheduled report was successfully deleted. Any issue encountered during the request to delete scheduled report(s) would result in an error message.

Field name

Type

Example

Description

status

string

true

Status of requested operation to delete the scheduled report(s).

Status - Description
true- Scheduled report was successfully deleted.

Any issue encountered during the request to delete scheduled report(s) would result in an error message.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports

	GET /reportCenter/reports
Method	GET
URL or End Point	/v1/reportCenter/reports
Headers	Authorization, Content-Type
Query Parameters	offset, limit, duration, sorts, statuses
Body	Not applicable

This method gets a list of all reports triggered for generation by this user. These reports may have been successfully generated, in the process of generating, or failed to generate. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made for a list of reports successfully generated by the user in the last week to be sorted by report name in ascending order. The response returned one report per page.

curl -X
GET "https://api.equinix.com/v1/reportCenter/reports?offset=0&limit=1&duration=14&sorts=REPORT_NAME&statuses=SUCCESS"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example	Applicable Values	Description
offset	No	integer	0		The starting index of the returned response. E.g. If '0', the first account returned would be account number 1 from the search results. If '1', the first account returned would be account number 2 from the search results. Default value: 0.
limit	No	integer	1		The maximum number of search results to be shown per page. Default value: 10. Minimum value: 1. Maximum value: 100.
duration	No	integer	14		The number of days from the date this request is submitted from which to pull the list of generated reports from. E.g. To pull the list of generated reports from the last 2 weeks, input '14'. Default value: 7. Minimum value: 1. Maximum value: 365.
sorts	No	array[string]	REPORT_NAME	REPORT_NAME, GENERATED_DATE, REQUESTED_DATE, -REPORT_NAME, -GENERATED_DATE, -REQUESTED_DATE	The sorting preference for the returned list of generated reports. This list can be arranged by report name, generated date, or requested date in ascending or descending order. To sort by descending order, the applicable value must start with a '-'. Sorts - Description REPORT_NAME - Reports will be arranged by report name in ascensing order. GENERATED_DATE - Reports will be arranged by generated date in ascending numerical order. REQUESTED_DATE - Reports will be arranged by the date the user requested the report in ascending order. -REPORT_NAME - Reports will be arranged by report name in descending order. -GENERATED_DATE - Reports will be arranged by generated date in descending order. -REQUESTED_DATE - Reports will be arranged by the date the user requested the report in descending order. Default value: -GENERATED_DATE
statuses	No	array[string]	SUCCESS	IN_PROGRESS, SUCCESS, ERROR	Filter of reports by their status. Multiple statuses should be comma-separated. Status - Description IN_PROGRESS - Report is being generated or is delayed. SUCCESS - Report is successfully generated. ERROR - Report could not be generated due to error. Default values: IN_PROGRESS,SUCCESS,ERROR

{
  "data": [
    {
      "reportId": "cc12349b-123d-12a1-a123-cce1bef123b1",
      "scheduledId": "1234b12b-af12-123f-a12b-123fb1fb1234",
      "reportName": "audit_report",
      "fileName": "AuditReport_JOHNDOECORP_2019_09_26_10_26_52_221.xlsx",
      "fileType": "XLS",
      "fileSize": 16395,
      "createdFor": "123321",
      "requestedDate": "2019-09-26T10:26:48.489Z",
      "generatedDate": "2019-09-26T10:26:52.438Z",
      "status": "SUCCESS",
      "numberOfDownloads": 0
    }
  ],
  "page": {
    "total": 53,
    "limit": 1,
    "offset": 0,
    "sorts": [
      "REPORT_NAME"
    ]
  },
  "_links": {
    "prev": {
      "href": "/reports?duration=14&limit=1&statuses=SUCCESS&offset=0&sorts=REPORT_NAME"
    },
    "self": {
      "href": "/reports?duration=14&limit=1&statuses=SUCCESS&offset=0&sorts=REPORT_NAME"
    },
    "next": {
      "href": "/reports?duration=14&limit=1&statuses=SUCCESS&offset=1&sorts=REPORT_NAME"
    }
  }
}

The description of the response payload is as follows:

Field name	Type	Example	Description
data	array[objects]		Data list of generated reports.
reportId	string	cc12349b-123d-12a1-a123- cce1bef123b1	Identification (ID) number of the generated report. This number is unique to each generated report.
scheduledId	string	1234b12b-af12-123f-a12b-123fb1fb1234	ID number of the scheduled report. All reports, whether recurring or ad-hoc, will be issued with a scheduled ID number. This is different from the report ID number, which is the ID number for a generated report.
reportName	string	audit_report	Name of report. Name of report - Description occupied_ports_report - Occupied Ports report returns a summary list of occupied ports by patch panel. orders_report - Orders report returns a list of all orders related to IBX by status, product type and date range. user_details_report - User Details report returns a list of users with their corresponding permissions and access. ibx_notification_report - IBX and Network Notification report returns a summary list of all IBX maintenance and network notifications by status, notification and date range. audit_report - User Audit report returns a list of users with any changes made to their corresponding permissions and access. install_base_report - Install Base report returns a list of all your assets. This included cages, cabinets, power and interconnections. traffic_report - Traffic report returns the network traffic for a specific port. order_notification_report - Order Notification report returns notifications related to IBX by notification type and date range.
fileName	string	AuditReport_JOHNDOECORP_ 2019_09_26_10_26_52_221.xlsx	File name of report. This is only provided when the report was successfully generated. This is not provided for reports in progress or with error.
fileType	string	XLS	The file type that the document can be downloaded in. File type - Description XLS - Excel spreadsheet.
fileSize	number	16395	File size of the report in bytes.
createdFor	string	123321	Equinix reference of the user who this report was generated for. You may ignore this.
requestedDate	string	2019-09-26T10:26:48.489Z	The date and time the user requested the generation of this report. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
generatedDate	string	2019-09-26T10:26:52.438Z	The date and time the report was generated. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
status	string	SUCCESS	The status of report generation. Status - Description IN_PROGRESS - Report is being generated. This comes under the 'IN_PROGRESS' status filter. DELAYED - Report generation is delayed. This comes under the 'IN_PROGRESS' status filter. SUCCESS - Report is successfully generated. This comes under the 'SUCCESS' status filter. ERROR - Report could not be generated due to error. This comes under the 'ERROR' status filter. INACTIVE - There is no report activity.
numberOfDownloads	integer	0	Indicates the number of times the generated report was downloaded by the user.
page	object		Page information that includes total number of reports, the limit of results per page, the offest, and the sorting preference.
total	integer	53	The total number of reports returned.
limit	integer	1	The number of reports displayed per page, as defined in the 'limit' query parameter.
offset	integer	0	The starting index of the returned response, as defined in the 'offset' query parameter.
sorts	array[string]	REPORT_NAME	The sorting preference of the results, as defined in the 'sorts' query parameter.
_links	object		Links that show the previous page, current page, and next page of search results.
prev	object		Previous search results page.
href	string	/reports?duration=14&limit=1&statuses =SUCCESS&offset=0&sorts =REPORT_NAME	Link to the previous page of search results.
self	object		Current search results page.
href	string	/reports?duration=14&limit=1&statuses =SUCCESS&offset=0&sorts =REPORT_NAME	Link to the current page of search results.
next	object		Next search results page.
href	string	/reports?duration=14&limit=1&statuses =SUCCESS&offset=1&sorts =REPORT_NAME	Link to the next page of search results.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports Definitions

	GET /reportCenter/reports/definitions
Method	GET
URL or End Point	/v1/reportCenter/reports/definitions
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method returns a list of all reports and their parameters, and indicates if the user can or cannot request these reports based on their existing permissions. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are looking for one report type only, refer to GET Reports Definitions {reportName} under the API Reference section for more information.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API.

curl -X
GET "https://api.equinix.com/v1/reportCenter/reports/definitions"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

[
  {
    "name": "orders_report",
    "parameters": [
      {
        "name": "ibxs",
        "type": "ARRAY"
      },
      {
        "name": "endDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "orderStatus",
        "value": "QUOTE_IN_PROGRESS,QUOTE_IN_REVIEW,QUOTE_ORDER_SUBMITTED,QUOTE_PENDING_CUSTOMER_ACCEPTANCE,QUOTE_CUSTOMER_ACCEPTED,QUOTE_EXPIRED,QUOTE_CANCELLED,ENTERED,BOOKED,SUBMITTED,PENDING_QA,IN_PROGRESS,PENDING_INFLIGHT,PARTIAL_SUBMISSION,CANCELLED,CLOSED,ON_HOLD,APPROVED,AWAITING_CUSTOMER_APPROVAL,CART_SAVED,COMPLETE,CUSTOMER_APPROVED,CUSTOMER_UPDATED,DRAFT_SAVED,EXPEDITE_AWAITING_CUSTOMER_RESPONSE,ON_HOLD_OTHER,ON_HOLD_PII,OPEN,PENDING,PENDING_CANCELLATION,PENDING_CUSTOMER,QUOTE_CUSTOMER_REJECTED,REQUESTED,REJECTED,SEE_DETAILS",
        "type": "ARRAY"
      },
      {
        "name": "productTypes",
        "value": "ACCESSORY,ADD_SECURITY_ACCESS,CABINET,CAGE,CLOUD_EXCHANGE_CONNECTIONS,CLOUD_EXCHANGE_PORT,CONFERENCE_ROOM,CROSS_CONNECT,EQUINIX_CONNECT_PORT,IBX_SMART_VIEW,IBX_SMARTVIEW_SENSOR,INBOUND_SHIPMENT,INTERNET_EXCHANGE_PORT,METRO_CONNECT,OTHER,OUTBOUND_SHIPMENT,POWER,REMOVE_SECURITY_ACCESS,SMART_HANDS,TOUR_REQUESTS,TROUBLE,WORK_VISIT",
        "type": "ARRAY"
      },
      {
        "name": "startDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "ALLOW",
    "categories": [
      "SITE_AND_ENVIRONMENT",
      "ASSET"
    ]
  },
  {
    "name": "occupied_ports_report",
    "parameters": [
      {
        "name": "cage",
        "type": "STRING"
      },
      {
        "name": "ppNumber",
        "type": "ARRAY"
      },
      {
        "name": "cabinet",
        "type": "STRING"
      },
      {
        "name": "ibx",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "DENY",
    "categories": [
      "ASSET"
    ]
  },
  {
    "name": "user_details_report",
    "parameters": [
      {
        "name": "userStatuses",
        "value": "NEW,ACTIVE,APPROVED,INACTIVE,TERMINATED",
        "type": "ARRAY"
      },
      {
        "name": "permissionCodes",
        "value": "MASTER_ADMINISTRATOR,IBX_ADMINISTRATOR,ECP_PORTAL_ACCESS_AND_ORDERING,IBX_DATA_CENTER_ACCESS_ALL,IBX_DATA_CENTER_ACCESS_ONLY,VIEW_INSTALL_BASE,VIEW_BILLING_AND_PAYMENT_STATEMENTS,IBX_AND_NETWORK_NOTIFICATIONS,PENDING_SHIPMENT_NOTIFICATIONS,DEVELOPER_PORTAL,INTERNET_EXCHANGE_PORTAL,EQUINIX_CONNECT,CLOUD_EXCHANGE_PORTAL",
        "type": "ARRAY"
      },
      {
        "name": "permissionMatchType",
        "value": "ANY",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "DENY",
    "categories": [
      "SECURITY"
    ]
  },
  {
    "name": "ibx_notification_report",
    "parameters": [
      {
        "name": "ibxStatus",
        "value": "NEW,UPDATED,RESOLVED,IN_PROGRESS,RESCHEDULED,EXTENDED,COMPLETED,CANCELLED",
        "type": "ARRAY"
      },
      {
        "name": "endDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "ibxType",
        "value": "IBX_MAINTENANCE,IBX_INCIDENT,IBX_ADVISORY,NETWORK_MAINTENANCE,NETWORK_INCIDENT,IBX_SMARTVIEW,MS_INCIDENT,MS_IBX_MAINTENANCE,MS_NETWORK_MAINTENANCE,IBX_SECURITY_INCIDENT",
        "type": "ARRAY"
      },
      {
        "name": "ibxinfo",
        "type": "ARRAY"
      },
      {
        "name": "startDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "DENY",
    "categories": [
      "SITE_AND_ENVIRONMENT",
      "ASSET"
    ]
  },
  {
    "name": "audit_report",
    "parameters": [
      {
        "name": "endDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "permissionMatchType",
        "value": "ANY",
        "type": "STRING"
      },
      {
        "name": "userStatuses",
        "value": "NEW,ACTIVE,APPROVED,INACTIVE,TERMINATED",
        "type": "ARRAY"
      },
      {
        "name": "isDisplayEqAdminInfo",
        "value": "false",
        "type": "BOOLEAN"
      },
      {
        "name": "permissionCodes",
        "value": "MASTER_ADMINISTRATOR,IBX_ADMINISTRATOR,ECP_PORTAL_ACCESS_AND_ORDERING,IBX_DATA_CENTER_ACCESS_ALL,IBX_DATA_CENTER_ACCESS_ONLY,VIEW_INSTALL_BASE,VIEW_BILLING_AND_PAYMENT_STATEMENTS,IBX_AND_NETWORK_NOTIFICATIONS,PENDING_SHIPMENT_NOTIFICATIONS,DEVELOPER_PORTAL,INTERNET_EXCHANGE_PORTAL,EQUINIX_CONNECT,CLOUD_EXCHANGE_PORTAL",
        "type": "ARRAY"
      },
      {
        "name": "startDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "DENY",
    "categories": [
      "SECURITY"
    ]
  },
  {
    "name": "install_base_report",
    "parameters": [
      {
        "name": "showReports",
        "value": "ALL,CAGE,CABINET,CUSTOMER_PROVIDED_CABINET,PATCH_PANEL,POWER,OTHERS,IBX_SMARTVIEW_SENSOR, IBX_SMARTVIEW,EQUINIX_ETHERNET_EXCHANGE,CLOUD_EXCHANGE,CROSS_CONNECT,ACCESSORIES",
        "type": "ARRAY"
      },
      {
        "name": "ibxs",
        "type": "ARRAY"
      },
      {
        "name": "endDate",
        "type": "STRING"
      },
      {
        "name": "cages",
        "type": "ARRAY"
      },
      {
        "name": "startDate",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "DENY",
    "categories": [
      "ASSET"
    ]
  },
  {
    "name": "traffic_report",
    "parameters": [
      {
        "name": "virtualPortId",
        "type": "STRING"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "DENY",
    "categories": [
      "ASSET"
    ]
  },
  {
    "name": "order_notification_report",
    "parameters": [
      {
        "name": "endDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "ibxinfo",
        "type": "ARRAY"
      },
      {
        "name": "startDate",
        "value": "YYYY-MM-DD",
        "type": "STRING"
      },
      {
        "name": "status",
        "value": "ORDER_COMPLETED,ORDER_MODIFIED,ORDER_RECEIVED,ORDER_SCHEDULED,EXPIRED_CANCELLED,SHIPMENT_NOTIFICATION,ORDERS_REQUIRING_APPROVAL,EXPEDITE",
        "type": "ARRAY"
      },
      {
        "name": "notifyEmails",
        "type": "ARRAY"
      }
    ],
    "control": "ALLOW",
    "categories": [
      "SITE_AND_ENVIRONMENT",
      "ASSET"
    ]
  }
]

The description of the response payload is as follows:

Field name	Type	Example	Description
name	string	orders_report	Name of report. Name of report - Description orders_report - Orders report returns a list of all orders submitted by the user or all orders from the user's organization. occupied_ports_report - Occupied Ports report returns a list of occupied ports by patch panel. user_details_report - User Details report returns a list of users with their contact, permissions and access information. ibx_notification_report - IBX Notification report returns a list of IBX, Network, and Managed Services notifications received by the user. audit_report - User Audit report returns a list of users with any changes made to their corresponding permissions and access. install_base_report - Install Base report returns a summary of assets to the user. traffic_report - Traffic report returns the network traffic for a specific port. order_notification_report - Order Notification report returns a list of all order notifications received by the user. For a full list of report names and the corresponding parameters, refer to Reports Definitions: Names and Parameters under the Appendix section.
parameters	array[objects]		List of parameters specific to each report. The parameters filter the data set for the report. For a full list of report names and the corresponding parameters, refer to Reports Definitions: Names and Parameters under the Appendix section.
name	string	endDate	Parameter name. E.g. endDate indicates that the end date for a particular notification can be found in this report. When startDate and endDate are included in the report's parameter names, this indicates that the report generates information based on a selected time period. This period can be selected when requesting a report. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
value	string	YYYY-MM-DD	Parameter value. This indicates the display format or enum values that apply to the parameter. E.g. YYYY-MM-DD indicates that the date will be displayed in the ISO 8601 date format. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	STRING	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
control	string	ALLOW	Indicates if the user is granted permission to request this report. File type - Description ALLOW- User is allowed to request for this report type, as they have the related permission. DENY - User is denied request for this report type, as they do not have the related permission. Permission that the user should have to request following reports:- orders_report : Any portal permission. If the user has View All Users' Requests permission (under the Administation & Ordering permission catalog), they will also be able to see all orders made by other users in their organization. occupied_ports_report : Cross Connect & Intra-Facility Cables, under the Administation & Ordering permission catalog. user_details_report : Manage Users permission, under the Administation & Ordering permission catalog. only for Administrators ibx_notification_report : IBX Notifications, Network Notifications, or Managed Services Notifications permission. audit_report : Manage Users permission, under the Administation & Ordering permission catalog. only for Administrators install_base_report : Install Base permission. traffic_report : Equinix Connect permission. order_notification_report : Any portal permission.
categories	array[strings]	SITE_AND_ENVIRONMENT, ASSET	Categories that this report comes under. You may ignore this.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports Definitions {reportName}

	GET /reportCenter/reports/definitions/{reportName}
Method	GET
URL or End Point	/v1/reportCenter/reports/definitions/{reportName}
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method returns a specific report and its parameters, and indicates if the user can or cannot request this report based on their existing permissions. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are looking for all report types, refer to GET Reports Definitions under the API Reference section for more information.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API.

curl -X
GET "https://api.equinix.com/v1/reportCenter/reports/definitions/install_base_report"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the URL parameter is as follows:

URL Parameter Name

Mandatory

Type

Example

Applicable Values

Description

reportName

Yes

string

install_base_report

occupied_ports_report,
orders_report,
user_details_report,
ibx_notification_report,
audit_report,
install_base_report,
traffic_report,
order_notification_report

Name of report.

Name of report - Description

orders_report - Orders report returns a list of all orders submitted by the user or all orders from the user's organization.

occupied_ports_report - Occupied Ports report returns a list of occupied ports by patch panel.

user_details_report - User Details report returns a list of users with their contact, permissions and access information.

ibx_notification_report - IBX Notification report returns a list of IBX, Network, and Managed Services notifications received by the user.

audit_report - User Audit report returns a list of users with any changes made to their corresponding permissions and access.

install_base_report - Install Base report returns a summary of assets to the user.

traffic_report - Traffic report returns the network traffic for a specific port.

order_notification_report - Order Notification report returns a list of all order notifications received by the user.

For a full list of permissions required to request for each report, refer to the description of the response payload field name 'control'.

{
  "name": "install_base_report",
  "parameters": [
    {
      "name": "showReports",
      "value": "ALL,CAGE,CABINET,CUSTOMER_PROVIDED_CABINET,PATCH_PANEL,POWER,OTHERS,IBX_SMARTVIEW_SENSOR, IBX_SMARTVIEW,EQUINIX_ETHERNET_EXCHANGE,CLOUD_EXCHANGE,CROSS_CONNECT,ACCESSORIES",
      "type": "ARRAY"
    },
    {
      "name": "ibxs",
      "type": "ARRAY"
    },
    {
      "name": "endDate",
      "type": "STRING"
    },
    {
      "name": "cages",
      "type": "ARRAY"
    },
    {
      "name": "startDate",
      "type": "STRING"
    },
    {
      "name": "notifyEmails",
      "type": "ARRAY"
    }
  ],
  "control": "ALLOW",
  "categories": [
    "ASSET"
  ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
name	string	install_base_report	Name of report. For a full list of report names and the corresponding parameters, refer to Reports Definitions: Names and Parameters under the Appendix section.
parameters	array[objects]		List of paramaters specific to each report. The parameters filter the data set for the report. For a full list of report names and the corresponding parameters, refer to Reports Definitions: Names and Parameters under the Appendix section.
name	string	showReports	Parameter name. E.g. showReports filters the asset types that should be included in the report. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
value	string	ALL, CAGE, CABINET, CUSTOMER_PROVIDED_CABINET, PATCH_PANEL, POWER, OTHERS, IBX_SMARTVIEW_SENSOR, IBX_SMARTVIEW, EQUINIX_ETHERNET_EXCHANGE, CLOUD_EXCHANGE, CROSS_CONNECT, ACCESSORIES	Parameter value. This indicates the display format or enum values that apply to the parameter. The values for 'showReports' are the applicable asset types that should be included in the report. Show reports value - Description ALL - All assets inclusive of cage, cabinet, customer provided cabinet, patch panel, power, IBX Smartview Sensor, IBX Smartview, Equinix Ethernet Exchange, Cloud Exchange, cross connect, accessories, and others. OTHERS - All other asset types not listed. CAGE - Cage in the data centre. CABINET - Cabinet provided by Equinix. CUSTOMER_PROVIDED_CABINET - Cabinet provided by customer. PATCH_PANEL - Patch panel. POWER - Power. OTHERS - All other asset types not listed. IBX_SMARTVIEW_SENSOR - IBX Smartview Environment Sensor. IBX_SMARTVIEW - IBX Smartview. EQUINIX_ETHERNET_EXCHANGE - Equinix Carrier Ethernet Exchange. CLOUD_EXCHANGE - Equinix Cloud Exchange Fabric. CROSS_CONNECT - Cross connect. ACCESSORIES - Accessories. For further description of these assets, refer to the Glossary. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	ARRAY	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
name	string	ibxs	Parameter name. E.g. ibxs filters the assets linked to these specific IBXs that should be included in the report. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	ARRAY	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
name	string	endDate	Parameter name. E.g. endDate indicates the end date of the report. When startDate and endDate are included in the report's parameter names, this indicates that the report generates information based on a selected time period. This period can be selected when requesting a report. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
value	string	YYYY-MM-DD	Parameter value. This indicates the display format or enum values that apply to the parameter. E.g. YYYY-MM-DD indicates that the date will be displayed in the ISO 8601 date format. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	STRING	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
name	string	cages	Parameter name. E.g. cages filters the assets linked to these specific cages that should be included in the report. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	ARRAY	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
name	string	startDate	Parameter name. E.g. startDate indicates the start date of the report. When startDate and endDate are included in the report's parameter names, this indicates that the report generates information based on a selected time period. This period can be selected when requesting a report. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
value	string	YYYY-MM-DD	Parameter value. This indicates the display format or enum values that apply to the parameter. E.g. YYYY-MM-DD indicates that the date will be displayed in the ISO 8601 date format. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	STRING	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
name	string	notifyEmails	Parameter name. E.g. notifyEmails are the email addresses that the report will be sent to once generated. It is important to include ALL the parameter names and values when requesting a report, unless these parameter names and/or values are to be excluded.
type	string	ARRAY	Data type of the parameter in the Equinix system. Data types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
control	string	ALLOW	Indicates if the user is granted permission to request this report. File type - Description ALLOW- User is allowed to request for this report type, as they have the related permission. DENY - User is denied request for this report type, as they do not have the related permission. Permission that the user should have to request following reports:- orders_report : Any portal permission. If the user has View All Users' Requests permission (under the Administation & Ordering permission catalog), they will also be able to see all orders made by other users in their organization. occupied_ports_report : Cross Connect & Intra-Facility Cables, under the Administation & Ordering permission catalog. user_details_report : Manage Users permission, under the Administation & Ordering permission catalog. only for Administrators ibx_notification_report : IBX Notifications, Network Notifications, or Managed Services Notifications permission. audit_report : Manage Users permission, under the Administation & Ordering permission catalog. only for Administrators install_base_report : Install Base permission. traffic_report : Equinix Connect permission. order_notification_report : Any portal permission.
categories	array[strings]	ASSET	Categories that this report comes under. You may ignore this.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports Files

	GET /reportCenter/reports/files
Method	GET
URL or End Point	/v1/reportCenter/reports/files
Headers	Authorization, Content-Type
Query Parameters	reportIds
Body	Not applicable

This method downloads a list of report documents generated by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made for a report with report ID number, 12c3ad4c-123b-12c3-b12e-a1bdbbd23ca4, and the document was returned for download.

curl -X
GET
"https://api.equinix.com/v1/reportCenter/reports?reportIds=12c3ad4c-123b-12c3-b12e-a1bdbbd23ca4,22c3ad4c-123b-12c3-b12e-a1bdbbd23ca4"
-H "content-type: application/octet-stream"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name

Mandatory

Type

Example

Applicable Values

Description

reportIds

Yes

array[string]

12c3ad4c-123b-12c3-b12e-a1bdbbd23ca4,
22c3ad4c-123b-12c3-b12e-a1bdbbd23ca4

Report identification (ID) number.

Multiple report ID numbers should be comma-separated.

The maximum number of reports that can be downloaded at a time is 20.

To get a list of all report ID numbers for reports that were successfully generated, refer to GET Reports under the API reference section.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports Scheduler

	GET /reportCenter/reports/scheduler
Method	GET
URL or End Point	/v1/reportCenter/reports/scheduler
Headers	Authorization, Content-Type
Query Parameters	offset, limit, sorts
Body	Not applicable

This method gets a list of recurring scheduled reports requested by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made for a list of scheduled reports generated by the user returned in ascending order of report name. The response returned one report per page.

curl -X
GET "https://api.equinix.com/v1/reportCenter/reports/scheduler?limit=1&sorts=REPORT_NAME"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name

Mandatory

Type

Example

Applicable Values

Description

offset

integer

The starting index of the returned response.

E.g. If '0', the first account returned would be account number 1 from the search results.
If '1', the first account returned would be account number 2 from the search results.

Default value: 0.

limit

integer

The maximum number of search results to be shown per page.

Default value: 10.
Minimum value: 1.
Maximum value: 100.

sorts

array[string]

REPORT_NAME

REPORT_NAME,
CREATED_DATE,
-REPORT_NAME,
-CREATED_DATE

The sorting preference for the returned list of generated reports.

This list can be arranged by report name, generated date, or requested date in ascending or descending order.

To sort by descending order, the applicable value must start with a '-'.

Sorts - Description
REPORT_NAME - Reports will be arranged by report name in ascensing order.
CREATED_DATE - Reports will be arranged by created date in ascending numerical order.
-REPORT_NAME - Reports will be arranged by report name in descending order.
-CREATED_DATE - Reports will be arranged by created date in descending order.

Default value: -CREATED_DATE

{
  "data": [
    {
      "scheduledId": "1234b12b-af12-123f-a12b-123fb1fb1234",
      "reportName": "order_notification_report",
      "scheduleType": "DAILY",
      "period": "1_DAY",
      "createdBy": "johndoe",
      "createdDate": "2019-11-18T04:22:18.538Z",
      "lastAttemptedDate": "2020-01-01T04:22:18.538Z",
      "customerOrganizationId": 1234,
      "forOrg": 1234,
      "forUser": "987654",
      "lastModifiedBy": "johndoe",
      "lastModifiedDate": "2019-11-20T04:22:18.538Z",
      "numberOfFailedAttempts": 0,
      "status": "ACTIVE",
      "parameters": [
        {
          "name": "ibxinfo",
          "value": "AM1,AM2,AT2,CH1,CH2",
          "type": "ARRAY"
        },
        {
          "name": "status",
          "value": "ORDER_RECEIVED,ORDER_SCHEDULED,ORDER_COMPLETED",
          "type": "ARRAY"
        },
        {
          "name": "notifyEmails",
          "value": "johndoe@johndoecorp.com"
        },
        {
          "name": "PARAM_ORG_NAME",
          "value": "SMITHCORP",
          "type": "STRING"
        },
        {
          "name": "custOrgId",
          "value": "1234",
          "type": "STRING"
        },
        {
          "name": "userCustOrgId",
          "value": "1234",
          "type": "STRING"
        },
        {
          "name": "username",
          "value": "johndoe",
          "type": "STRING"
        }
      ],
      "reports": []
    }
  ],
  "page": {
    "total": 53,
    "limit": 1,
    "offset": 0,
    "sorts": [
      "REPORT_NAME"
    ]
  },
  "_links": {
    "prev": {
      "href": "/reports/scheduler?limit=1&offset=0&sorts=REPORT_NAME"
    },
    "self": {
      "href": "/reports/scheduler?limit=1&offset=0&sorts=REPORT_NAME"
    },
    "next": {
      "href": "/reports/scheduler?limit=1&offset=1&sorts=REPORT_NAME"
    }
  }
}

The description of the response payload is as follows:

Field name	Type	Example	Description
data	array[object]		Data list of scheduled reports.
scheduledId	string	1234b12b-af12-123f-a12b-123fb1fb1234	Identification (ID) number of the scheduled report. All reports, whether recurring or ad-hoc, will be issued with a schedule ID number. This is different from the report ID number, which is the ID number for a generated report.
reportName	string	order_notification_report	The name or type of report. The type of report a user can generate depends on their permissions. Name of report - Description occupied_ports_report - Occupied Ports report returns a summary list of occupied ports by patch panel. orders_report - Orders report returns a list of all orders related to IBX by status, product type, and date range. user_details_report - User Details report returns a list of users with their corresponding permissions and access. ibx_notification_report - IBX and Network Notification report returns a summary list of all IBX maintenance and network notifications by status, notification and date range. audit_report - User Audit report returns a list of users with any changes made to their corresponding permissions and access. install_base_report - Install Base report returns a list of all your assets. This included cages, cabinets, power, and interconnections. traffic_report - Traffic report returns the network traffic for a specific port. order_notification_report - Order Notification report returns notifications related to IBX by notification type and date range.
scheduleType	string	DAILY	Scheduled frequency for generation of report. Schedule type - Description ONE_TIME - Report generated based on one-time request. DAILY - Report generated every day. WEEKLY - Report generated every week. MONTHLY - Report generated every month. QUARTERLY - Report generated every three months. ANNUALLY - Report generated every year.
period	string	1_DAY	Date range from which report publishes data. Period - Description 1_DAY - Report generated based on data from the past 1 day. 7_DAYS - Report generated based on data from the past 7 days. 14_DAYS - Report generated based on data from the past 14 days. 30_DAYS - Report generated based on data from the past 30 days. 90_DAYS - Report generated based on data from the past 90 days. 180_DAYS - Report generated based on data from the past 180 days. 1_YEAR - Report generated based on data from the past 1 year. CUSTOM - Report generated based on customized date range. NONE - Report will generate based on all data, but this is only applicable for Occupied Ports, Install Base, and User Details reports. If NONE is selected for all other report types, the reports will be blank.
createdBy	string	johndoe	Username of the user who first triggered or scheduled this report.
createdDate	string	2019-11-18T04:22:18.538Z	The date and time this report was first scheduled. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
lastAttemptedDate	string	2020-01-01T04:22:18.538Z	The last date and time the report was requested to be generated. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
customerOrganizationId	integer	1234	ID number of the customer organization of the user who triggered this report.
forOrg	integer	1234	ID number of the customer organization of the user who this report was scheduled for.
forUser	string	987654	Equinix reference of the user who this report was scheduled for. You may ignore this.
lastModifiedBy	string	johndoe	Username of the user who last updated this report. If this report was not updated, this field would not appear.
lastModifiedDate	string	2019-11-20T04:22:18.538Z	The last date and time the report was updated. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ. If this report was not updated, this field would not appear.
numberOfFailedAttempts	integer	0	Number of times the generation of report failed.
status	string	ACTIVE	The scheduling status of report generation. Status - Description ACTIVE - The report generation schedule is in effect. INACTIVE - The report generation schedule is no longer in effect. SUSPENDED - The report generation schedule has been suspended.
parameters	array[objects]		Indicates the parameters linked to the scheduled report. It is important to take note of the parameter names and values listed for each recurring report, as these would need to be included when updating the recurring report. The following parameter names may be ignored when updating a report, as their values cannot be changed: PARAM_ORG_NAME, custOrgId, userCustOrgId, username.
name	string	ibxinfo	Parameter name. E.g. 'ibxinfo' refers to the IBXs that should be included in the report. The description of the other parameter names may be found below. Parameter name (found in this example) - Description status- The order statuses of the notifications that should be included in the report. notifyEmails - Email addresses that this report was sent to. PARAM_ORG_NAME - The parent customer organization that related to this report. custOrgId - The customer organization ID number that this report is for. userCustOrgId - The customer organization of the user who this report was scheduled for. username - The Equinix registered username of the user this report was scheduled for.
value	string	AM1, AM2, AT2, CH1, CH2	Parameter value. The values for 'ibxinfo' are IBX location codes.
type	string	ARRAY	Parameter type. Parameter types ARRAY - Array indicates that more than one value may be included, and multiple values should be comma-separated. STRING - String indicates that only one value may be included. This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.
reports	array		Array of generated scheduled reports. More reports information will be provided when searching for a specified scheduled report. Refer to GET Reports Scheduler {scheduleId} under the API Reference section for more information.
page	object		Page information that includes total number of reports, the limit of results per page, the offest, and the sorting preference.
total	integer	53	The total number of reports returned.
limit	integer	1	The number of reports displayed per page, as defined in the 'limit' query parameter.
offset	integer	0	The starting index of the returned response, as defined in the 'offset' query parameter.
sorts	array[string]	REPORT_NAME	The sorting preference of the results, as defined in the 'sorts' query parameter.
_links	object		Links that show the previous page, current page, and next page of search results.
prev	object		Previous search results page.
href	string	/reports/scheduler?limit=1&offset=0&sorts=REPORT_NAME	Link to the previous page of search results.
self	object		Current search results page.
href	string	/reports/scheduler?limit=1&offset=0&sorts=REPORT_NAME	Link to the current page of search results.
next	object		Next search results page.
href	string	/reports/scheduler?limit=1&offset=0&sorts=REPORT_NAME	Link to the next page of search results.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports Scheduler {scheduleId}

	GET /reportCenter/reports/scheduler/{scheduleId}
Method	GET
URL or End Point	/v1/reportCenter/reports/scheduler/{scheduleId}
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method gets all the generated report details of a specific recurring scheduled report requested by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made for a scheduled report with ID number, 1234b12b-af12-123f-a12b-123fb1fb1234. The response returned report details related to this scheduled report.

curl -X
GET
"https://api.equinix.com/v1/reportCenter/reports/scheduler/1234b12b-af12-123f-a12b-123fb1fb1234"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

URL Parameter Name	Mandatory	Type	Example	Applicable Values	Description
scheduledId	Yes	string	1234b12b-af12-123f-a12b-123fb1fb1234		Identification (ID) number of the scheduled report. Only one number can be searched for at a time. If you are not sure of the scheduled ID, refer to GET Reports Scheduler under the API Reference section for more information.

{
  "scheduledId": "1234b12b-af12-123f-a12b-123fb1fb1234",
  "reportName": "install_base_report",
  "scheduleType": "ONE_TIME",
  "period": "CUSTOM",
  "createdBy": "johndoe",
  "createdDate": "2019-11-18T04:22:18.538Z",
  "lastAttemptedDate": "2019-11-18T04:22:18.538Z",
  "customerOrganizationId": 1234,
  "forOrg": 1234,
  "forUser": "987654",
  "numberOfFailedAttempts": 0,
  "status": "ACTIVE",
  "parameters": [
    {
      "name": "ibxs",
      "value": "AM1",
      "type": "ARRAY"
    },
    {
      "name": "cages",
      "value": "AM1:03:010704,AM1:03:010705",
      "type": "ARRAY"
    },
    {
      "name": "showReports",
      "value": "ACCESSORIES,CABINET,CAGE,CUSTOMER_PROVIDED_CABINET",
      "type": "ARRAY"
    },
    {
      "name": "notifyEmails",
      "value": "janesmith@johndoecorp.com,jonifulan@johndoecorp.com",
      "type": "ARRAY"
    },
    {
      "name": "startDate",
      "value": "2019-07-01",
      "type": "STRING"
    },
    {
      "name": "endDate",
      "value": "2020-01-30",
      "type": "STRING"
    },
    {
      "name": "PARAM_ORG_NAME",
      "value": "JOHNDOECORP",
      "type": "STRING"
    },
    {
      "name": "custOrgId",
      "value": "1234",
      "type": "STRING"
    },
    {
      "name": "userCustOrgId",
      "value": "1234",
      "type": "STRING"
    },
    {
      "name": "username",
      "value": "johndoe",
      "type": "STRING"
    }
  ],
  "reports": [
    {
      "reportId": "ffb1cb2d-d123-1b42-beb1-1b234ce5678",
      "scheduledId": "1234b12b-af12-123f-a12b-123fb1fb1234",
      "createdBy": "987654",
      "createdDate": "2019-11-18T06:17:49.412Z",
      "startTime": "2019-11-18T06:17:49.42Z",
      "endTime": "2019-11-18T06:17:50.07Z",
      "status": "SUCCESS",
      "location": "abcd2e96-f988-46g6-860h-379i8jklm84n",
      "numberOfDownloads": 0,
      "numberOfAttempts": 1,
      "parameters": [
        {
          "name": "ibxs",
          "value": "AM1",
          "type": "ARRAY"
        },
        {
          "name": "cages",
          "value": "AM1:03:010704,AM1:03:010705",
          "type": "ARRAY"
        },
        {
          "name": "showReports",
          "value": "ACCESSORIES,CABINET,CAGE,CUSTOMER_PROVIDED_CABINET",
          "type": "ARRAY"
        },
        {
          "name": "startDate",
          "value": "2019-07-01",
          "type": "STRING"
        },
        {
          "name": "endDate",
          "value": "2020-01-30",
          "type": "STRING"
        },
        {
          "name": "custOrgId",
          "value": "8128",
          "type": "STRING"
        },
        {
          "name": "userCustOrgId",
          "value": "8128",
          "type": "STRING"
        },
        {
          "name": "contactUCId",
          "value": "796757",
          "type": "STRING"
        },
        {
          "name": "scheduleType",
          "value": "ONE_TIME",
          "type": "STRING"
        },
        {
          "name": "userLocale",
          "value": "EN_GB",
          "type": "STRING"
        },
        {
          "name": "userTimezone",
          "value": "Asia/Singapore",
          "type": "STRING"
        },
        {
          "name": "notifyEmails",
          "value": "janesmith@johndoecorp.com,jonifulan@johndoecorp.com",
          "type": "ARRAY"
        },
        {
          "name": "username",
          "value": "johndoe",
          "type": "STRING"
        },
        {
          "name": "PARAM_ORG_NAME",
          "value": "JOHNDOECORP",
          "type": "STRING"
        }
      ],
      "publisherInfo": {
        "file_name": "InstallBase_SMITHCORP_2019_11_18_06_17_49_964.xlsx",
        "document_id": "abcd2e96-f988-46g6-860h-379i8jklm84n",
        "document_size": "4182",
        "document_type": "XLS"
      }
    }
  ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
scheduledId	string	1234b12b-af12-123f-a12b-123fb1fb1234	ID number of the scheduled report. All reports, whether recurring or ad-hoc, will be issued with a scheduled ID number. This is different from the report ID number, which is the ID number for a generated report.
reportName	string	install_base_report	The name or type of report. The type of report a user can generate depends on their permissions. Report name - Description occupied_ports_report - Occupied Ports report returns a summary list of occupied ports by patch panel. orders_report - Orders report returns a list of all orders related to IBX by status, product type and date range. user_details_report - User Details report returns a list of users with their corresponding permissions and access. ibx_notification_report - IBX and Network Notification report returns a summary list of all IBX maintenance and network notifications by status, notification and date range. audit_report - User Audit report returns a list of users with any changes made to their corresponding permissions and access. install_base_report - Install Base report returns a list of all your assets. This included cages, cabinets, power and interconnections. traffic_report - Traffic report returns the network traffic for a specific port. order_notification_report - Order Notification report returns notifications related to IBX by notification type and date range.
scheduleType	string	ONE_TIME	Scheduled frequency for generation of report. Schedule type - Description ONE_TIME - Report generated based on one time request. DAILY - Report generated everyday. WEEKLY - Report generated every week. MONTHLY - Report generated every month. QUARTERLY - Report generated every three months. ANNUALLY - Report generated every year.
period	string	CUSTOM	Date range from which report publishes data. Period - Description 1_DAY - Report generated based on data from the past 1 day. 7_DAYS - Report generated based on data from the past 7 days. 14_DAYS - Report generated based on data from the past 14 days. 30_DAYS - Report generated based on data from the past 30 days. 90_DAYS - Report generated based on data from the past 90 days. 180_DAYS - Report generated based on data from the past 180 days. 1_YEAR - Report generated based on data from the past 1 year. CUSTOM - Report generated based on customized date range. NONE - Report will generate based on all data, but this is only applicable for Occupied Ports, Install Base, and User Details reports. If NONE is selected for all other report types, the reports will be blank.
createdBy	string	johndoe	User who first requested the report to be generated.
createdDate	string	2019-11-18T04:22:18.538Z	The date and time this report was first created. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
lastAttemptedDate	string	2019-11-18T04:22:18.538Z	The last date and time the report was requested to be generated. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
customerOrganizationId	integer	1234	ID number of the customer organization that requested the report to be generated.
forOrg	integer	1234	ID number of the customer organization that the requested report is for.
forUser	string	987654	Equinix reference of the user. You may ignore this.
lastModifiedBy	string		Username of the user who last updated the report.
lastModifiedDate	string		The last date and time the report was updated. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
numberOfFailedAttempts	integer	0	Number of times the generation of report failed.
status	string	ACTIVE	The scheduling status of report generation. Status - Description ACTIVE - The report generation schedule is in effect. INACTIVE - The report generation schedule is no longer in effect. SUSPENDED - The report generation schedule has been suspended.
parameters	array[objects]		Indicates the parameters linked to the scheduled report. It is important to take note of the parameter names and values listed for each scheduled report, as these would need to be included in any updates to this report later. The folllowing parameter names may be ignored as their values cannot be changed: PARAM_ORG_NAME, custOrgId, userCustOrgId, username.
name	string	ibxs	Parameter name. 'ibxs' refers to the specific IBXs that are included in the report. The description of the other parameter names may be found below. Parameter name (found in this example) - Description cages - Specific cages where the assets are located. showReports - Asset types that are included in the report. notifyEmails - Email addresses that this report was sent to. startDate - The custom start date of the report. endDate - The custom end date of the report. PARAM_ORG_NAME - The parent customer organization that related to this report. custOrgId - The parent customer organization's ID number. userCustOrgId - The customer organization that the requesting user belongs to, represented by the customer organization ID number. username - The requesting user's Equinix registered username.
value	string	AM1	Parameter value. The values for 'ibxs' are IBX location codes.
type	string	ARRAY	Parameter type. Parameter types ARRAY - Array indicates that more than one value may be included, and multiple values should be comma-separated. STRING - String indicates that only one value may be included. This is not reflective of how the value is passed in the request body. All values are passed as STRING in the request body when scheduling a report.
reports	array[objects]		Array of generated scheduled reports.
reportId	string	ffb1cb2d-d123-1b42-beb1-1b234ce5678	ID number of the generated report. This number is unique to each generated report.
scheduledId	string	1234b12b-af12-123f-a12b-123fb1fb1234	Scheduled ID number that this generated report belongs to.
createdBy	string	987654	Equinix reference of the user who this report was generated for. You may ignore this.
createdDate	string	2019-11-18T06:17:49.412Z	The date and time this report was first created. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
startTime	string	2019-11-18T06:17:49.42Z	Processing start date and time of this report. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
endTime	string	2019-11-18T06:17:50.07Z	Processing end date and time of this report. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
status	string	SUCCESS	Status of report generation. Status - Description IN_PROGRESS - Report is being generated. DELAYED - Report is experiencing a delay in generation. SUCCESS - Report was successfully generated. ERROR - An error was encountered during report generation. INACTIVE - Report is not being generated.
errorMessage	string		Contains an error message if report status is 'ERROR'.
location	string	abcd2e96-f988-46g6-860h-379i8jklm84n	Location ID number of the report once it is generated. This is also known as the publisher information document ID number.
numberOfDownloads	integer	0	Number of times this report was downloaded.
numberOfAttempts	integer	1	Number of times attempted to generate this report.
parameters	array[objects]		Indicates the parameters linked to the specific generated report.
name	string	ibxs	Parameter name. 'ibxs' refers to the specific IBXs that are included in the report. The description of the other parameter names may be found below. Parameter name (found in this example) - Description cages - Specific cages where the assets are located. showReports - Asset types that are included in the report. notifyEmails - Email addresses that this report was sent to. startDate - The custom start date of the report. endDate - The custom end date of the report. PARAM_ORG_NAME - The parent customer organization that related to this report. custOrgId - The parent customer organization's ID number. userCustOrgId - The customer organization that the requesting user belongs to, represented by the customer organization ID number. username - The requesting user's Equinix registered username.
value	string	AM1	Parameter value. The values for 'ibxs' are IBX location codes.
type	string	ARRAY	Parameter type. Parameter types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as STRING in the request body when scheduling a report.
publisherInfo	object		Publisher information related to this generated report.
file_name	string	InstallBase_SMITHCORP _2019_11_18_06_17_49_964.xlsx	Name of the generated report.
document_id	string	abcd2e96-f988-46g6-860h-379i8jklm84n	Document ID number of the report once it is generated. This is also known as the location ID number of the report.
document_size	string	4182	Size of the generated report in bytes.
document_type	string	XLS	File type of the generated report. Document type - Description XLS - Excel

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports {reportId}

	GET /reportCenter/reports/{reportId}
Method	GET
URL or End Point	/v1/reportCenter/reports/{reportId}
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method returns details of a specific generated report requested by the user. The report may have may have been successfully generated, is in the process of generating, or failed to generate. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made for a generated report with ID number, ffb1cb2d-d123-1b42-beb1-1b234ce5678. The response returned details related to this specific report.

curl -X
GET "https://api.equinix.com/v1/reportCenter/reports/ffb1cb2d-d123-1b42-beb1-1b234ce5678"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Example	Applicable Values	Description
reportId	Yes	string	ffb1cb2d-d123-1b42-beb1-1b234ce5678		Identification (ID) number of the generated report. This number is unique to each generated report. Only one number can be searched for at a time.

{
  "reportId": "ffb1cb2d-d123-1b42-beb1-1b234ce5678",
  "scheduledId": "1234b12b-af12-123f-a12b-123fb1fb1234",
  "createdBy": "987654",
  "createdDate": "2019-11-18T06:17:49.412Z",
  "startTime": "2019-11-18T06:17:49.42Z",
  "endTime": "2019-11-18T06:17:50.07Z",
  "status": "SUCCESS",
  "location": "abcd2e96-f988-46g6-860h-379i8jklm84n",
  "numberOfDownloads": 0,
  "numberOfAttempts": 1,
  "parameters": [
    {
      "name": "ibxs",
      "value": "AM1",
      "type": "ARRAY"
    },
    {
      "name": "cages",
      "value": "AM1:03:010704,AM1:03:010705",
      "type": "ARRAY"
    },
    {
      "name": "showReports",
      "value": "ACCESSORIES,CABINET,CAGE,CUSTOMER_PROVIDED_CABINET",
      "type": "ARRAY"
    },
    {
      "name": "startDate",
      "value": "2019-07-01",
      "type": "STRING"
    },
    {
      "name": "endDate",
      "value": "2020-01-30",
      "type": "STRING"
    },
    {
      "name": "custOrgId",
      "value": "8128",
      "type": "STRING"
    },
    {
      "name": "userCustOrgId",
      "value": "8128",
      "type": "STRING"
    },
    {
      "name": "contactUCId",
      "value": "796757",
      "type": "STRING"
    },
    {
      "name": "scheduleType",
      "value": "ONE_TIME",
      "type": "STRING"
    },
    {
      "name": "userLocale",
      "value": "EN_GB",
      "type": "STRING"
    },
    {
      "name": "userTimezone",
      "value": "Asia/Singapore",
      "type": "STRING"
    },
    {
      "name": "notifyEmails",
      "value": "janesmith@johndoecorp.com,jonifulan@johndoecorp.com",
      "type": "ARRAY"
    },
    {
      "name": "username",
      "value": "johndoe",
      "type": "STRING"
    },
    {
      "name": "PARAM_ORG_NAME",
      "value": "JOHNDOECORP",
      "type": "STRING"
    }
  ],
  "publisherInfo": {
    "file_name": "InstallBase_SMITHCORP_2019_11_18_06_17_49_964.xlsx",
    "document_id": "abcd2e96-f988-46g6-860h-379i8jklm84n",
    "document_size": "4182",
    "document_type": "XLS"
  }
}

The description of the response payload is as follows:

Field name	Type	Example	Description
reportId	string	ffb1cb2d-d123-1b42-beb1-1b234ce5678	ID number of the generated report.
scheduledId	string	1234b12b-af12-123f-a12b-123fb1fb1234	ID number of the scheduled report. All reports, whether recurring or ad-hoc, will be issued with a scheduled ID number. This is different from the report ID number, which is the ID number for a generated report.
createdBy	string	987654	Equinix reference of the user who this report was generated for. You may ignore this.
createdDate	string	2019-11-18T06:17:49.412Z	The date and time this report was first created. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
startTime	string	2019-11-18T06:17:49.42Z	Processing start date and time of this report. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
endTime	string	2019-11-18T06:17:50.07Z	Processing end date and time of this report. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
status	string	SUCCESS	Status of report generation. Status - Description IN_PROGRESS - Report is being generated. DELAYED - Report is experiencing a delay in generation. SUCCESS - Report was successfully generated. ERROR - An error was encountered during report generation. INACTIVE - Report is not being generated.
errorMessage	string		Contains an error message if report status is 'ERROR'.
location	string	abcd2e96-f988-46g6-860h-379i8jklm84n	Location ID number of the report once it is generated. This is also known as the publisher information document ID number.
numberOfDownloads	integer	0	Number of times this report was downloaded.
numberOfAttempts	integer	1	Number of times attempted to generate this report.
parameters	array[objects]		Indicates the parameters linked to the specific generated report.
name	string	ibxs	Parameter name. 'ibxs' refers to the specific IBXs that are included in the report. The description of the other parameter names may be found below. Parameter name (found in this example) - Description cages - Specific cages where the assets are located. showReports - Asset types that are included in the report. startDate - The custom start date of the report. endDate - The custom end date of the report. custOrgId - The customer organization ID number that this report is for. userCustOrgId - The customer organization of the user who this report was scheduled for. contactUCId - Equinix reference of the user. You may ignore this. scheduleType - Scheduled frequency for generation of report. userLocale - The requesting user's language preference, and the language the report is generated in. userTimezone - The time zone of the requesting user. notifyEmails - The email addresses that the report will be sent to once generated, including the requesting user. username - The requesting user's Equinix registered username. PARAM_ORG_NAME - The parent customer organization that related to this report.
value	string	AM1	Parameter value. The values for 'ibxs' are IBX location codes.
type	string	ARRAY	Parameter type. Parameter types ARRAY - Array indicates that more than one value may be included, and multiple values should be comma-separated. STRING - String indicates that only one value may be included. This is not reflective of how the value is passed in the request body. All values are passed as STRING in the request body when scheduling a report.
publisherInfo	object		Publisher information related to this generated report.
file_name	string	InstallBase_SMITHCORP _2019_11_18_06_17_49_964.xlsx	Name of the generated report.
document_id	string	abcd2e96-f988-46g6-860h-379i8jklm84n	Document ID number of the report once it is generated. This is also known as the location ID number of the report.
document_size	string	4182	Size of the generated report in bytes.
document_type	string	XLS	File type of the generated report. Document type - Description XLS - Excel

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Reports {reportId} File

	GET /reportCenter/reports/{reportId}/file
Method	GET
URL or End Point	/v1/reportCenter/reports/{reportId}/file
Headers	Authorization, Content-Type
Query Parameters	reportIds
Body	Not applicable

This method downloads a specific report generated by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

curl -X
GET
"https://api.equinix.com/v1/reportCenter/reports?reportIds=12c3ad4c-123b-12c3-b12e-a1bdbbd23ca4"
-H "content-type: application/octet-stream"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example	Applicable Values	Description
reportIds	No	integer	12c3ad4c-123b-12c3-b12e-a1bdbbd23ca4		Report identification (ID) number. To get a list of all report ID numbers for reports that were successfully generated, refer to GET ReportsCenter Reports under the API reference section.

If you get “Insufficient permissions” error, contact your Master Administrator.

POST Reports Scheduler {scheduledId} Report

	POST /reportCenter/reports/scheduler/{scheduledId}/report
Method	GET
URL or End Point	/v1/reportCenter/reports/scheduler/{scheduledId}/report
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method requests a specific scheduled report to be generated by the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The request was made for a scheduled report with ID number, 1234b12b-af12-123f-a12b-123fb1fb1234, to be generated. The response returned details related to this specific report.

curl -X
POST
"https://api.equinix.com/v1/reportCenter/reports/scheduler/1234b12b-af12-123f-a12b-123fb1fb1234/report"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Example	Applicable Values	Description
scheduledId	Yes	string	1234b12b-af12-123f-a12b-123fb1fb1234		Identification (ID) number of the scheduled report. Only one number can be searched for at a time. If you are not sure of the schedule ID, refer to GET Reports Scheduler under the API Reference section for more information.

{
  "reportId": "ffb1cb2d-d123-1b42-beb1-1b234ce5678",
  "scheduledId": "1234b12b-af12-123f-a12b-123fb1fb1234",
  "createdBy": "987654",
  "createdDate": "2019-11-18T06:17:49.412Z",
  "status": "IN_PROGRESS",
  "location": "abcd2e96-f988-46g6-860h-379i8jklm84n",
  "numberOfDownloads": 0,
  "numberOfAttempts": 1,
  "parameters": [
    {
      "name": "ibxs",
      "value": "AM1",
      "type": "ARRAY"
    },
    {
      "name": "cages",
      "value": "AM1:03:010704,AM1:03:010705",
      "type": "ARRAY"
    },
    {
      "name": "showReports",
      "value": "ACCESSORIES,CABINET,CAGE,CUSTOMER_PROVIDED_CABINET",
      "type": "ARRAY"
    },
    {
      "name": "startDate",
      "value": "2019-07-01",
      "type": "STRING"
    },
    {
      "name": "endDate",
      "value": "2020-01-30",
      "type": "STRING"
    },
    {
      "name": "custOrgId",
      "value": "8128",
      "type": "STRING"
    },
    {
      "name": "userCustOrgId",
      "value": "8128",
      "type": "STRING"
    },
    {
      "name": "contactUCId",
      "value": "796757",
      "type": "STRING"
    },
    {
      "name": "scheduleType",
      "value": "ONE_TIME",
      "type": "STRING"
    },
    {
      "name": "userLocale",
      "value": "EN_GB",
      "type": "STRING"
    },
    {
      "name": "userTimezone",
      "value": "Asia/Singapore",
      "type": "STRING"
    },
    {
      "name": "notifyEmails",
      "value": "janesmith@johndoecorp.com,jonifulan@johndoecorp.com",
      "type": "ARRAY"
    },
    {
      "name": "username",
      "value": "johndoe",
      "type": "STRING"
    },
    {
      "name": "PARAM_ORG_NAME",
      "value": "JOHNDOECORP",
      "type": "STRING"
    }
  ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
reportId	string	ffb1cb2d-d123-1b42-beb1-1b234ce5678	ID number of the generated report.
scheduledId	string	1234b12b-af12-123f-a12b-123fb1fb1234	ID number of the scheduled report that this generated report belongs to.
createdBy	string	987654	Equinix reference of the user. You may ignore this.
createdDate	string	2019-11-18T06:17:49.412Z	The date and time this report was first created. The date and time are represented in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSZ.
status	string	IN_PROGRESS	Status of report generation. Status - Description IN_PROGRESS - Report is being generated. DELAYED - Report is experiencing a delay in generation. SUCCESS - Report was successfully generated. ERROR - An error was encountered during report generation. INACTIVE - Report is not being generated.
errorMessage	string		Contains an error message if report status is 'ERROR'.
location	string	abcd2e96-f988-46g6-860h-379i8jklm84n	Location ID number of the report once it is generated. This is also known as the publisher information document ID number.
numberOfDownloads	integer	0	Number of times this report was downloaded.
numberOfAttempts	integer	1	Number of times attempted to generate this report.
parameters	array[objects]		Indicates the parameters linked to the specific generated report.
name	string	ibxs	Parameter name. 'ibxs' refers to the specific IBXs that are included in the report. The description of the other parameter names may be found below. Parameter name (found in this example) - Description cages - Specific cages where the assets are located. showReports - Asset types that are included in the report. notifyEmails - Email addresses that this report was sent to. startDate - The custom start date of the report. endDate - The custom end date of the report. custOrgId - The parent customer organization's ID number. userCustOrgId - The customer organization that the requesting user belongs to, represented by the customer organization ID number. contactUCId - Equinix reference of the user. You may ignore this. scheduleType - Scheduled frequency for generation of report. userLocale - The requesting user's language preference, and the language the report is generated in. userTimezone - The time zone of the requesting user. notifyEmails - The email addresses that the report will be sent to once generated, including the requesting user. username - The requesting user's Equinix registered username. PARAM_ORG_NAME - The parent customer organization that related to this report.
value	string	AM1	Parameter value. The values for 'ibxs' are IBX location codes.
type	string	ARRAY	Parameter type. Parameter types ARRAY STRING LONG INT BOOLEAN DOUBLE JSON JSON_ARRAY This is not reflective of how the value is passed in the request body. All values are passed as string in the request body when scheduling a report.

If you get “Insufficient permissions” error, contact your Master Administrator.

DELETE Reports​

DELETE Reports Scheduler​

GET Reports​

GET Reports Definitions​

GET Reports Definitions {reportName}​

GET Reports Files​

GET Reports Scheduler​

GET Reports Scheduler {scheduleId}​

GET Reports {reportId}​

GET Reports {reportId} File​

POST Reports Scheduler {scheduledId} Report​

DELETE Reports

DELETE Reports Scheduler

GET Reports

GET Reports Definitions

GET Reports Definitions {reportName}

GET Reports Files

GET Reports Scheduler

GET Reports Scheduler {scheduleId}

GET Reports {reportId}

GET Reports {reportId} File

POST Reports Scheduler {scheduledId} Report