What is the endpoint for [P056]Create Patent Monitor Project?

The [P056]Create Patent Monitor Project endpoint is GET https://connect.patsnap.com/patent-alert/create.

What data can [P056]Create Patent Monitor Project return?

[P056]Create Patent Monitor Project Create patent monitor project by query. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [P056]Create Patent Monitor Project?

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

[P056]Create Patent Monitor Project

get

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

Try in Sandbox

Create patent monitor project by query.

The maximum number of monitored patents is 500000.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`query` Required	`string`	`ANC:(智慧芽)`	query of the monitor project
`content` Required	`string`	`new,invention,legal`	1.New patents(new):Alert when a new patent matching the search query is published 2.New invention(invention):Alert when a new patent that does not belong to an existing family is published 3.Legal status(legal):Alert when patent legal status changes 4.Assignment(transfer):Alert if the current assignee of the patent changes 5.Upcoming expiry date(expired):Alert when patents are within 30 days of the estimated expiry date 6.Licensing(license):Alert when licensing information has been updated 7.Litigation(litigation):Alert when litigation information has been updated Please enter the parameter, multiple selections are allowed, and the multiple monitored items are separated by ,.
`alert_name`	`string`	`Intelligent bud company monitoring`	monitor name or tag, up to 50 characters

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`number`	`integer<int64>`	`4800`	original patent counts in monitor project
`alert_id`	`string`	`7f22ee78764149b481314b1fa60dca0c`	monitor project ID
`alert_name`	`string`	`Intelligent bud company monitoring`	Name of Monitoring Project
`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": {
    "number": 4800,
    "alert_id": "7f22ee78764149b481314b1fa60dca0c",
    "alert_name": "智慧芽公司监控"
  },
  "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