Cloud Services API ReferenceSmart HomeData Dashboard ServiceBasic DataGet data of custom interface

Get data of custom interface

Last Updated on : 2023-07-28 06:25:03download

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 name	Type	IN	Required	Description
api_code	String	query	false	The apiCode generated when the API was created on the data analysis platform
params	String	query	false	Customized parameters when creating an API on the data analysis platform, in JSON format

Return parameter

Parameter name	Type	Description
result	Object

Description of result

Parameter name	Type	Description
success	Boolean	Whether the request was successful
errorCode	String	The error code when the interface fails, the data is not returned when it succeeds
errorMsg	String	The error message when the interface fails, there is no such field when it succeeds
resultDO	Object	Returned specific data

Description of resultDO

Parameter name	Type	Description
data	List	The specific data of the response, the format inside is the return value format defined when you created the API on the data analysis platform
pageNo	Integer	The current page
totalCount	Integer	How 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.

Prev DocBasic Data

Next DocGet Data Overview of Active Devices