GET Custom Report Details

Overview

---

The following table contains important information about the GET method in regards to receiving a custom report's details.

GET Custom Report Details
Method	GET
URL or Endpoint	/api/projects/projectId/custom-report/id
Headers	Authorization
Parameters	projectId, id
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
id	Yes	string	Unique id of the custom report.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": ["string"],
  "messages": ["string"],
  "result": {
    "id": 0,
    "name": "string",
    "dateFrom": "2022-04-05T14:47:54.247Z",
    "dateTo": "2022-04-05T14:47:54.247Z",
    "customReportDateRangeId": 0,
    "reportDimensions": [
      {
        "id": 0,
        "display": "string",
        "key": "string"
      }
    ],
    "reportMetrics": [
      {
        "id": 0,
        "display": "string",
        "key": "string"
      }
    ],
    "reportFilters": [
      {
        "id": 0,
        "filterOperatorId": 0,
        "customReportId": 0,
        "filterOperatorDisplay": "string",
        "filterDisplay": "string",
        "value": "string"
      }
    ]
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The ID of the custom report.
name	string	The name of the custom report.
dateFrom	string(Date)	The starting date the custom report.
dateTo	string(Date)	The end date of the custom report.
customReportDateRangeId	integer($int32)	The date range ID of the custom report.
reportDimensions	array[Object]	An array of objects that contains the custom report dimensions.
id	integer($int32)	The id of the object.
key	string	The key of the object.
display	string	The display of the object.
reportMetrics	array[Object]	An array of objects that contains the custom report metrics.
reportFilters	array[Object]	An array of objects that contains the custom report filters
id	integer($int32)	The ID of the custom report filter.
filterOperatorId	integer($int32)	The ID of the filter operator.
customReportId	integer($int32)	The ID of the custom report.
filterOperatorDisplay	string	The display of the filter operator.
filterDisplay	string	The display of the filter.
value	string	The value of the filter.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed