Document

description

Document

type Document {
  id: String!
  pageCount: Int!
  type: DocumentType!
  version: Float!
  releasedAt: Float!
  remainingBillablePages: Int
  remainingPrice: Float
  isIndexed: Boolean!
  title: String!
  lastProcessedAt: Float!
  summary: [String!]
  companies(
    category: CompanyDocumentCategory = PRIMARY
  ): [Company!]!
  citiLinkBackUrls: CitiLinkBackUrls
  countryCodes: [String!]
  documentAuthors: [String!]
  source: SourceInfo
  sentiment: Sentiment
  sectors: [IndustrySector!]
  industries: [IndustryBranch!]
  subIndustries: [SubIndustry!]
  kpiClusters: [DocumentKpiCluster!]!
  topicClusters: [DocumentTopicCluster!]
  images: [DocumentImage!]
  imageCount: Int!
  relevanceScore: Float
  commentsCount: Int
  snippets(
    keywordFilter: KeywordHitsFilter
    limit: Int = 5
    offset: Int = 0
  ): KeywordResult
  aiSummaryModules: [AISummaryModule]
}

Fields

Document.id ● String! non-null scalar

Primary document id @exposed

Document.pageCount ● Int! non-null scalar

Number of pages in a document. For some cases when the number of pages is not defined for a document, it would be 0. @exposed

Document.type ● DocumentType! non-null interface

Interface describes document's type (filing type, source type, etc). Implementations could provide type-specific additional data. @exposed

Document.version ● Float! non-null scalar

DDS version @exposed(scopes: ['docviewer'])

Document.releasedAt ● Float! non-null scalar

Time value as epoch when document was released by vendor. This is acceptance date time for public documents.

Exact meaning may be different for different document types. @exposed

Document.remainingBillablePages ● Int scalar

The remaining number of unpurchased pages of the current user for this document @exposed(scopes: ['docviewer'])

Document.remainingPrice ● Float scalar

The remaining price that the current user needs to pay in order to get all the unpurchased pages of this document @exposed(scopes: ['docviewer'])

Document.isIndexed ● Boolean! non-null scalar

True if document is fully available for search @exposed(scopes: ['docviewer'])

Document.title ● String! non-null scalar

Document title @exposed

Document.lastProcessedAt ● Float! non-null scalar

The date and time when the document was last processed. This refers to the most recent processing of the document. @exposed

Document.summary ● [String!] list scalar

The summary of document as list of statements. This field can be empty as every document doesn't have summary @exposed

Document.companies ● [Company!]! non-null object

Fetch companies. By default only primary companies are loaded.

To load both primary and secondary companies use aliases:

{ primary: companies { ... } secondary: companies(primaryOnly: False) { ... } } @exposed

Document.companies.category ● CompanyDocumentCategory enum

Document.citiLinkBackUrls ● CitiLinkBackUrls object

Linkback URLs for CITI docs @exposed(scopes: ['docviewer'])

Document.countryCodes ● [String!] list scalar

Country codes in ISO-3166-A2 format Eg: US, FI @exposed

Document.documentAuthors ● [String!] list scalar

List of Authors associated with user documenta @exposed

Document.source ● SourceInfo object

Contains key information about where a document comes from @exposed

Document.sentiment ● Sentiment object

Document sentiment data (the tone of a document on a spectrum of positive to negative). This value is available for specific types of documents only (for example, Transcripts). @exposed

Document.sectors ● [IndustrySector!] list object

GICS Sectors of the document, if available. Eg: 10 Energy @exposed

Document.industries ● [IndustryBranch!] list object

GICS Industries of the document, if available. Eg: 101010: Energy Equipment & Services @exposed

Document.subIndustries ● [SubIndustry!] list object

GICS Sub-industries of the document, if available. Eg: 10101010: Oil & Gas Drilling @exposed

Document.kpiClusters ● [DocumentKpiCluster!]! non-null object

Document KPIs are the Key Performance Indicators discussed in a given document and they are tied to some numeric value like a financial metrics that impact a business. This fields gives you all KPI Clusters for KPIs within document Eg: "Margins" as a cluster title, will most likely have this KPI Cluster name: "amount" value: "23.5%" DocumentKpiCluster data is only available for limited document types. Eg: Event Transcripts, Expert Calls. @exposed

Document.topicClusters ● [DocumentTopicCluster!] list object

This field gives the themes clusters of topics/key phrases from document. DocumentTopicCluster data is only available for limited document types. Eg: Event Transcripts, Expert Calls. @exposed

Document.images ● [DocumentImage!] list object

@exposed

Document.imageCount ● Int! non-null scalar

@exposed

Document.relevanceScore ● Float scalar

Only available in the scope of a search query and shows how relevant the document is for the search parameters. A float value between 0 (least relevant) and 100 (most relevant). @exposed

Document.commentsCount ● Int scalar

Total count of comments in a document @exposed

Document.snippets ● KeywordResult object

Allows getting snippets for the search query. API requests for snippets in Research documents are not supported. @exposed

Document.snippets.keywordFilter ● KeywordHitsFilter input

By default coming from search. The 'scope' field is ignored at the moment.

Document.snippets.limit ● Int scalar

Limits the number of snippets to return. The maximum limit is 20.

Document.snippets.offset ● Int scalar

Offset the results for pagination purposes

Document.aiSummaryModules ● [AISummaryModule] list object

AISummaryModules containing generated AI summaries for the document. @exposed

Returned by

documentsData query ● searchByDocId query

Member of

AISummaryModule object ● AISummaryReference object ● DocumentImage object ● SearchResponse object