The following function will retrieve a list of reports you have access to in the Dayforce Analytics feature. The information returned contains details about each report, such as the report's name and description. The content of each report will not be available in this function.
Overview
The Get reports request allows the consuming application to retrieve a list of available reports. Required parameters for the call include ClientNamespace and BearerToken, though the authorization provided by the BearerToken can also be provided through basic user authentication. The system will search for all of the reports that you have access to in the ad hoc reporting feature.
The URL for Get Analytics Reports uses the following base URL:
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Reports
Parameters
Note: An asterisk (*) next to a parameter name denotes a required parameter.
ClientNamespace* (string)
- Uniquely identifies the client's Dayforce instance. This is needed to log in.
BearerToken* (string)
- Authorization Token is mandatory for this API. Testing this API in the Dayforce Developer's Network (DDN) is not supported. This authorization may also be provided with basic user authentication.
Response
The response is in JSON format as illustrated in the example below:
{
"Data": [
{
"ReportId": "string",
"Name": "string",
"Description": "string"
}
],
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
]
}