What is the endpoint for [P057]Check Monitor Project Status?

The [P057]Check Monitor Project Status endpoint is GET https://connect.patsnap.com/patent-alert/check.

What data can [P057]Check Monitor Project Status return?

[P057]Check Monitor Project Status Check monitor project status. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [P057]Check Monitor Project Status?

The OpenAPI schema is available at /openapi.json#/paths/~1patent-alert~1check/get. You can also browse the full specification at /openapi.json.

[P057]Check Monitor Project Status

get

https://connect.patsnap.com/patent-alert/check

Try in Sandbox

Check monitor project status.

Weekly query and monthly query are recommended to call the API in advance to obtain updated data to prevent affecting the push function,the updated data is from the last query time to the current time.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`alert_id` Required	`string`	`7f22ee78764149b481314b1fa60dca0c`	monitor project ID

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`type`	`string`	`new`	monitor project type
`count`	`integer<int64>`	`1`	patents
`alert_name`	`string`	`Intelligent bud company monitoring`	Name of Monitoring Project
`patent_ids`	`array`	`[ "f052da16-1d93-46a6-9174-b653c69fd884" ]`	patent ID
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": [
    {
      "type": "new",
      "count": 1,
      "alert_name": "智慧芽公司监控",
      "patent_ids": [
        "f052da16-1d93-46a6-9174-b653c69fd884"
      ]
    }
  ],
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!
`67200007`	Exceeded the call limit, call failed!

HTTP Status Codes

Status Code	Description
`0`	Success