This function retrieves information about a dataset. You can only access datasets that you created.
Overview
The Get Dataset Metadata request allows the consuming application to retrieve the metadata (status and row) related to the report's dataset. Required parameters for the call include dataId, clientNamespace, and BearerToken, though the authorization provided by the BearerToken can also be provided through basic user authentication.
The URL for the Get Dataset Metadata request uses the following base URL:
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Datasets/datasetId/Metadata
Note: Datasets expire if they have not been accessed using the Get Dataset endpoint for 63 days. If a Get Dataset Metadata request is sent for an expired dataset, the response will show a status of “Expired”.
Parameters
Note: An asterisk (*) next to a parameter name denotes a required parameter.
datasetId* (string)
- Uniquely identifies a dataset.
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": {
"DatasetId": "string",
"Status": "string",
"RowCount": "string"
"ReportId": 0,
"Refresh Status": "string"
"Filters": "string",
"Parameters": "string",
},
Note: The "Refresh Status" is not displayed during the "Processing" or "Requested" status, or when the dataset has not been refreshed. Additionally, "Row Count" is not displayed during the "Requested" status, and "Filters" and "Parameters" are not displayed during the "Processing" or "Requested" status.