PITR
The PITR (Patent Intelligence & Technology Report) service offers users the ability to create pivot tables of data using the Solr JSON facet API. This service is a thin layer exposing multi-dimensional reporting on appropriate fields within an IFI CLAIMS Direct specialized Solr index.
/pitr/topn
This endpoint returns, at the least, a list of top assignees and corresponding publication counts per year and optionally, monthly within a year. Ranking is based on number of records within the most recent complete year.
Method(s) | GET | ||
---|---|---|---|
Path | /pitr/topn | ||
Parameter | Values | Description | |
@n | n=10 | Number of assignees to report, with precedence based on ranking (default: 10) | |
@min | min=1 | Minimum number of documents worthy of counting (default: 10) | |
@start | start=YYYY | Beginning year to filter (default: now() - 5 years) | |
@end | end=YYYY | Ending year to filter (default: current year) | |
@months | months=1|0 | Add monthly pivot values (default: 0) | |
@apps | apps=1|0 | Report on pre-grant publications instead of grants (default: 0) | |
@current | current=1|0 | Use current assignee instead of original (default: 0) | |
@probable | probable=1|0 | Consider probable assignees as well (default: 0) | |
@filter | filter=cpc:a61k | Any random Solr search to limit results | |
@countries | countries=US,EP,DE | Comma-delimited list of countries to report on. Note: These are publication countries, not countries of assignee (default: US) | |
@pivot | pivot=cpcl3 | Pivot field (any field from the PITR Solr index to generate pivot data for, computed per-assignee) | |
@pivot.mincount | pivot.mincount=1 | Minimum number of values from pivot considered worthy of counting (default: 1) | |
@pivot.limit | pivot.limit=5 | Maximum number of values to return, where precedence is given to most frequent values (default: 10) | |
@pivot.embed | pivot.embed=1|0 | Embed pivot field with years, i.e., break pivot down by both assignee and year rather than just by assignee (default: 0) |
Example: Top assignee assuming all default values
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'https://cdws21.ificlaims.com/pitr/topn?n=1'
Response JSON
{ "content" : [ { "years" : [ { "year" : 2013, "total" : 2145 }, { "year" : 2014, "total" : 7533 }, { "total" : 7353, "year" : 2015 }, { "year" : 2016, "total" : 8087 }, { "year" : 2017, "total" : 9043 }, { "year" : 2018, "total" : 4979 } ], "name" : "International Business Machines Corp", "country" : "US", "total" : 39140 } ], "time" : "0.517", "status" : "success" }
Example: Top assignee broken out into months
wget -O- -q \ |
Response JSON
{ "status" : "success", "content" : [ { "years" : [ { "year" : 2013, "months" : [ 154, 107, 90, 161, 135, 118, 221, 108, 157, 244, 218, 432 ], "total" : 2145 }, { "total" : 7533, "year" : 2014, "months" : [ 627, 571, 546, 571, 467, 555, 772, 715, 771, 669, 495, 774 ] }, { "year" : 2015, "months" : [ 622, 623, 713, 606, 518, 889, 574, 612, 617, 495, 486, 598 ], "total" : 7353 }, { "year" : 2016, "months" : [ 483, 814, 915, 663, 754, 505, 572, 751, 540, 729, 779, 582 ], "total" : 8087 }, { "total" : 9043, "year" : 2017, "months" : [ 758, 944, 784, 803, 842, 671, 763, 1101, 695, 709, 476, 497 ] }, { "months" : [ 948, 761, 912, 901, 742, 715, 0, 0, 0, 0, 0, 0 ], "year" : 2018, "total" : 4979 } ], "name" : "International Business Machines Corp", "country" : "US", "total" : 39140 } ], "time" : "0.195" }
Example: Pivoting values from separate field embedded under years
wget -O- -q \ |
Response JSON
{ "content" : [ { "name" : "International Business Machines Corp", "years" : [ { "year" : 2013, "cpcl3" : [ { "total" : 873, "value" : "h01l" }, { "value" : "g06f", "total" : 839 }, { "total" : 136, "value" : "h04l" } ], "total" : 2145 }, { "total" : 7533, "year" : 2014, "cpcl3" : [ { "value" : "g06f", "total" : 4148 }, { "total" : 1335, "value" : "h01l" }, { "value" : "h04l", "total" : 1288 } ] }, { "total" : 7353, "cpcl3" : [ { "total" : 4285, "value" : "g06f" }, { "value" : "h04l", "total" : 1420 }, { "value" : "h01l", "total" : 1169 } ], "year" : 2015 }, { "total" : 8087, "cpcl3" : [ { "value" : "g06f", "total" : 5115 }, { "total" : 1906, "value" : "h04l" }, { "total" : 1348, "value" : "h05k" } ], "year" : 2016 }, { "year" : 2017, "cpcl3" : [ { "total" : 5277, "value" : "g06f" }, { "value" : "h05k", "total" : 4739 }, { "value" : "h04l", "total" : 2209 } ], "total" : 9043 }, { "cpcl3" : [ { "value" : "g06f", "total" : 2833 }, { "total" : 1396, "value" : "h05k" }, { "value" : "h04l", "total" : 1213 } ], "year" : 2018, "total" : 4979 } ], "total" : 39140, "country" : "US" } ], "time" : "0.085", "status" : "success" }
Example: Filtering report on distinct criteria
This example requests the top 2 assignees who publish in the F16L CPC area (PIPES; JOINTS OR FITTINGS FOR PIPES; SUPPORTS FOR PIPES, CABLES OR PROTECTIVE TUBING; MEANS FOR THERMAL INSULATION IN GENERAL) concentrating on E03B (Water supply installations). Note, the @min parameter is reduced to 1 (default being 10) to satisfy this narrow search field.
wget -O- -q \ |
Response JSON
{ "status" : "success", "content" : [ { "name" : "ADEY HOLDINGS (2008) Ltd", "years" : [ { "year" : 2013, "total" : 0 }, { "year" : 2014, "total" : 0 }, { "total" : 0, "year" : 2015 }, { "total" : 0, "year" : 2016 }, { "total" : 0, "year" : 2017 }, { "year" : 2018, "total" : 3 } ], "total" : 3, "country" : "GB" }, { "total" : 2, "country" : "US", "name" : "AMTROL Licensing Inc", "years" : [ { "year" : 2013, "total" : 0 }, { "total" : 0, "year" : 2014 }, { "year" : 2015, "total" : 0 }, { "year" : 2016, "total" : 0 }, { "total" : 1, "year" : 2017 }, { "total" : 1, "year" : 2018 } ] } ], "time" : "0.130" }