GET Custom Report Fields

Overview

---

The following table contains important information about the GET method in regards to receiving custom report fields.

GET Custom Report Fields
Method	POST
URL or Endpoint	/api/custom-reports/fields
Headers	Authorization
Parameters	none
Body	none

Response

{
  "success": true,
  "errors": ["string"],
  "messages": ["string"],
  "result": {
    "dimensions": {
      "categories": [
        {
          "name": "string",
          "items": [
            {
              "display": "string",
              "key": "string"
            }
          ]
        }
      ]
    },
    "metrics": {
      "categories": [
        {
          "name": "string",
          "items": [
            {
              "display": "string",
              "key": "string"
            }
          ]
        }
      ]
    },
    "dateRanges": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "filters": [
      {
        "id": 0,
        "key": "string",
        "display": "string"
      }
    ]
  },
  "resultInfo": "string",
  "statusCode": 0
}

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.
dimensions	Object	An object that contains the dimensions of the custom report.
categories	array	An array that contains the categories of a dimension of a custom report.
name	string	The name of the category.
items	array[Object]	An array that contains the items of a category.
display	string	The display of the item
key	string	The key of the item.
metrics	Object	An object that contains the metrics of the custom report.
dateRanges	array[Object]	An array of objects that contains the date ranges of the custom report.
id	integer($int32)	The ID of the date range.
name	string	The name of the date range
filters	array[Object]	An array of objects that contains the filters of the custom reports.
id	integer($int32)	The id of the filter.
key	string	The key of the filter.
display	string	The display 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