What is the endpoint for Submit a new Landscape job?

The Submit a new Landscape job endpoint is POST https://connect.patsnap.com/landscape-api/jobs.

What data can Submit a new Landscape job return?

Submit a new Landscape job Create a new Landscape analysis job to process patent collection. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for Submit a new Landscape job?

The OpenAPI schema is available at /openapi.json#/paths/~1landscape-api~1jobs/post. You can also browse the full specification at /openapi.json.

Submit a new Landscape job

post

https://connect.patsnap.com/landscape-api/jobs

Try in Sandbox

Create a new Landscape analysis job to process patent collection.

The job will be processed asynchronously after creation

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`browser_uri`	`string`	`https://example.com/search?q=electric+vehicle`	Browser URI, original browser link of the request
`dashboard_id`	`string`	`dashboard123`	Dashboard ID, associated dashboard identifier
`description`	`string`	`Analysis of electric vehicle technologies`	Description, detailed description of the job
`exclude_expired_patent`	`boolean`	-	Whether to exclude expired patents
`expired_collapse`	`boolean`	`true`	Whether to filter expired patents
`filter_query`	`string`	`assignee:(Tesla)`	Filter query, used to filter results
`gid`	`array`	`[ "group1", "group2" ]`	Group ID list, identifies groups the user belongs to
`job_id` Required	`string`	`landscape_job_12345`	Job ID, uniquely identifies the Landscape job
`lang`	`string`	`en`	Language, specifies the language of results
`match`	`array`	`[ { "text": "artificial intelligence", "field": "title", "weight": 0.8 } ]`	Match item list, used for text matching analysis
`description`	`string`	`Advanced technologies for electric vehicle batteries`	Description, detailed description of match item
`digest_text`	`string`	`Electric vehicle battery technology`	Digest text, text digest of match item
`title` Required	`string`	`Electric vehicle battery technology`	Title, title information of match item
`oq`	`string`	`battery`	Other query string, supplementary search condition
`par_job_id`	`string`	`job123`	Parent job ID, associated parent job
`q` Required	`string`	`electric vehicle`	Query string, main search condition
`request_type` Required	`string`	`som`	Request type, specifies the processing type of Landscape job
`rows`	`integer<int32>`	`100`	Rows, specifies the size of result set
`stemming`	`boolean`	`true`	Whether to use stemming, affects text processing in search
`time_slices`	`string`	`year`	Time slices, specifies how to divide the time range
`time_start`	`string`	`2010-01-01`	Start time, starting point of time range for analysis
`time_stop`	`string`	`2020-12-31`	End time, ending point of time range for analysis
`time_type`	`string`	`filing_date`	Time type, specifies the type of time field to use
`title`	`string`	`Electric Vehicle Landscape Analysis`	Title, the title description of the job
`uid` Required	`string`	`user123`	User ID, identifies the requesting user

Request Example

Example request body for this API endpoint

JSON

{
  "q": "electric vehicle",
  "oq": "battery",
  "gid": [
    "group1",
    "group2"
  ],
  "uid": "user123",
  "lang": "en",
  "rows": 100,
  "match": [
    {
      "title": "Electric vehicle battery technology",
      "description": "Advanced technologies for electric vehicle batteries",
      "digest_text": "Electric vehicle battery technology"
    }
  ],
  "title": "Electric Vehicle Landscape Analysis",
  "job_id": "landscape_job_12345",
  "stemming": true,
  "time_stop": "2020-12-31",
  "time_type": "filing_date",
  "par_job_id": "job123",
  "time_start": "2010-01-01",
  "browser_uri": "https://example.com/search?q=electric+vehicle",
  "description": "Analysis of electric vehicle technologies",
  "time_slices": "year",
  "dashboard_id": "dashboard123",
  "filter_query": "assignee:(Tesla)",
  "request_type": "som",
  "expired_collapse": true,
  "exclude_expired_patent": false
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`string`	`123`	response data
`status`	`boolean`	`true`	response status

Success Response Example

Example of a successful API response

JSON

{
  "data": 123,
  "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
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms