fieldsdf {patentsview}

Fields data frame

Description

A data frame containing the names of retrievable and queryable fields for each of the 7 API endpoints. A yes/no flag (can_query) indicates which fields can be included in the user's query. You can also find this data on the API's online documentation for each endpoint as well (e.g., the patents endpoint field list table)

Usage

fieldsdf

Format

A data frame with 992 rows and 7 variables:

endpoint

The endpoint that this field record is for

field

The name of the field

data_type

The field's data type (string, date, float, integer, fulltext)

can_query

An indicator for whether the field can be included in the user query for the given endpoint

group

The group the field belongs to

common_name

The field's common name

description

A description of the field