Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method(s)GET
Path/pitr/topn
Parameter 
ValuesDescription 

@nn=10Number of assignees to report, with precedence based on ranking (default: 10)

@minmin=1Minimum number of documents worthy of counting (default: 10)

@startstart=YYYYBeginning year to filter (default: now() - 5 years)

@endend=YYYYEnding year to filter (default: current year)

@monthsmonths=1|0Add monthly pivot values (default: 0)

@appsapps=1|0Report on pre-grant publications instead of grants (default: 0)

@currentcurrent=1|0Use current assignee instead of original (default: 0)

@probableprobable=1|0Consider probable assignees as well (default: 0)

@filterfilter=cpc:a61kAny random SOLR search to limit results

@countriescountries=US,EP,DE

Comma-delimited list of countries to report on.

NOTE

Note:

these

These are publication countries, not countries of assignee (default: US)


@pivotpivot=cpcl3Pivot field (any field from the PITR SOLR index to generate pivot data for, computed per-assignee)

@pivot.mincountpivot.mincount=1Minimum number of values from pivot considered worthy of counting (default: 1)

@pivot.limitpivot.limit=5Maximum number of values to return, where precedence is given to most frequent values (default: 10)

@pivot.embedpivot.embed=1|0Embed 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

...

Example: Filtering report on distinct criteria

This example will request 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.

...