Get data of custom interface

Last Updated on : 2024-05-08 02:11:01download

Get the data of your custom created interface in the data center. For details on how to create an API in the data center, please refer to [API Management](https://developer.tuya.com/cn/docs/iot/data-services ?id=Ka6gsnnk5noeg).

API address

POST: /v1.0/data-analysis/data

Request parameter

Parameter nameTypeINRequiredDescription
api_codeStringqueryfalseThe apiCode generated when the API was created on the data analysis platform
paramsStringqueryfalseCustomized parameters when creating an API on the data analysis platform, in JSON format

Return parameter

Parameter nameTypeDescription
resultObject

Description of result

Parameter nameTypeDescription
successBooleanWhether the request was successful
errorCodeStringThe error code when the interface fails, the data is not returned when it succeeds
errorMsgStringThe error message when the interface fails, there is no such field when it succeeds
resultDOObjectReturned specific data

Description of resultDO

Parameter nameTypeDescription
dataListThe specific data of the response, the format inside is the return value format defined when you created the API on the data analysis platform
pageNoIntegerThe current page
totalCountIntegerHow many pieces of data are there in total

Request example

POST: /v1.0/data-analysis/data
{
  "apiCode": "yourApiCode",
  "params": {
    "fields": "your fields"
  }
}

Return example

{
    "result": {
        "resultDO": {
            "totalCount ": 1,
            "data": [
            ],
            "pageNo": 1
        },
        "success": true
    },
    "t": 1626250948216,
    "success": true
}

Error code

For more information, see error code.