Skip to main content
Version: Beta

2024-10-04 changelogs

Breaking changes​

notes These changes require special attention. If your app uses these API resources, and

you don’t adjust your usage of the resources according to the following instructions, then your app might break when you update to this API version. :::

Deprecations​

notes These deprecations will be removed in the next version. You should to consider to

change to another version to ensure that your application is up to date and not breaking in the next version. :::

GraphQL changes​

Not all items have a title.toA title that sums up or acts as an introduction to the content text.

Not all items have a title. @exposed`

  • Field AISummaryItem.content description changed from The main content of the summary answer. to The main content of the summary answer. @exposed
  • Field AISummaryItem.citations description changed from `Citations (pointing to data source references) that were used for generating the AI summary item.

Even though citations typically contain numbered labels (such as [1]), this type of representation is not made available in the schema.

Citations may not be available in all cases.toCitations (pointing to data source references) that were used for generating the AI summary item.

Even though citations typically contain numbered labels (such as [1]), this type of representation is not made available in the schema.

Citations may not be available in all cases. @exposed`

  • Field statementIds was added to object type AISummaryReference
  • Field pages was added to object type AISummaryReference
  • Field AISummaryReference.id description changed from `An identifier of the reference.

Could assist in identifying whether multiple AISummaryItems were generated with the help of the same data source.toAn identifier of the reference.

Could assist in identifying whether multiple AISummaryItems were generated with the help of the same data source. @exposed`

  • Field AISummaryReference.titleLong description changed from A long title for the reference. to A long title for the reference. @exposed
  • Field AISummaryReference.document description changed from The document that was used as a data source. to The document that was used as a data source. @exposed
  • Field AISummaryReference.statementId description changed from A unique identifier for a statement within a document. to A unique identifier for a statement within a document. @exposed
  • Field AISummaryReference.page description changed from Page number of the document in which the statement is present. to Page number of the document in which the statement is present. @exposed
  • Field AISummaryTopic.id description changed from The id of the topic. to The id of the topic. @exposed
  • Field AISummaryTopic.title description changed from The title of the topic, such as "Earnings highlights", "Earnings Lowlights", etc. to The title of the topic, such as "Earnings highlights", "Earnings Lowlights", etc. @exposed
  • Field user was added to object type BrokerResearchEntitlementRequest
  • Field BrokerResearchEntitlementRequest.requestedAt description changed from The date on which the request was created to The epoch timestamp on which the request was created
  • Field comment was added to object type BrokerResearchUserEntitlements
  • Input field BrokerResearchUserEntitlementUpdateInput.entitlementGroups changed type from [String!]! to [String!]
  • Field CommonUserDocumentType.updatedAt has description Last time the document was modified, incl. uploading, sharing, making annotations, etc. Read-only does not affect this timestamp.
  • Field hasSummaries was added to object type Company
  • Field Company.type description changed from Shows if its a public or private companytoShows if its a public or private company @exposed
  • Description @exposed(scopes: [enterprise-only]) on type CompanyType has changed to @exposed
  • Field CompanyUser.id description changed from Internal id of the user, used exclusively within our product to Internal id of the user, used exclusively within our product @exposed
  • Field CompanyUser.username has description @exposed
  • Field CompanyUser.firstName has description @exposed
  • Field CompanyUser.lastName has description @exposed
  • Field CompanyUser.email has description @exposed
  • Field CompanyUser.isActive has description @exposed
  • Field CompanyUsers.total description changed from Total number of the result hits, used for pagination to Total number of the result hits, used for pagination @exposed
  • Field CompanyUsers.users has description @exposed
  • Object type CompanyUsersSortField has description @exposed
  • Field Document.summary description changed from The summary of document as list of statements. This field can be empty as every document doesnt have summarytoThe summary of document as list of statements. This field can be empty as every document doesnt have summary @exposed
  • Field Document.source description changed from Contains key information about where a document comes from to Contains key information about where a document comes from @exposed
  • Field content was added to object type ExpertCallsDocumentType
  • Field relatedTranscripts was added to object type ExpertCallsDocumentType
  • Field coverageArea was added to object type ExpertCallsDocumentType
  • Field expert was added to object type ExpertCallsDocumentType
  • Field callDate was added to object type ExpertCallsDocumentType
  • Field ExpertCallsDocumentType.expertEmploymentType description changed from The employment type of the expert who has participated in the Expert Call to The employment type of the expert who has participated in the Expert Call @exposed
  • Field ExpertCallsDocumentType.perspectives description changed from The document perspective, the value is relation(s) of the interviewee to the company. This field can be empty as every document doesnt have perspective. For example: Customer, Competitor, Former`` to The document perspective, the value is relation(s) of the interviewee to the company. This field can be empty as every document doesnt have perspective. For example: Customer, Competitor, Former @exposed
  • Field ExpertCallsDocumentType.expertBio description changed from Short bio about the expert mentioned in the document to Short bio about the expert mentioned in the document @exposed
  • Field ExpertCallsDocumentType.focus description changed from Topic/Theme that the transcript focuses on to Topic/Theme that the transcript focuses on @exposed
  • Object type ExpertCallsFocus has description @exposed
  • Object type ExpertEmploymentType has description @exposed
  • Field NoteDocumentType.updatedAt has description Last time the document was modified, incl. uploading, sharing, making annotations, etc. Read-only does not affect this timestamp.
  • Field Query.suggestedTickers description changed from Returns companies tickers suggestions based on the input query and filings setting. to Returns companies tickers suggestions based on the input query and filings setting. @exposed
  • Field Query.companyUsers description changed from Fetches basic data for all users in the company. Querying data for users in a different company only available for global admins. to Fetches basic data for all users in the company. Querying data for users in a different company only available for global admins. @exposed
  • Description for argument companyId on field Query.companyUsers changed from Currently supports only global admin use case. That means companyId has to be present. Nullable due to future use case to Company id of the company to obtain information from
  • Input field SearchDateRange.from description changed from For example: 2020-08-01 In case of using pagination, make sure the value supplied here stays the same for each subsequent request. to For example: 2020-08-01 or 2020-08-01T14:30:00Z In case of using pagination, make sure the value supplied here stays the same for each subsequent request.
  • Input field SearchDateRange.to description changed from For example: 2020-08-01 In case of using pagination, make sure the value supplied here stays the same for each subsequent request. to For example: 2020-08-01 or 2020-08-01T14:30:00Z In case of using pagination, make sure the value supplied here stays the same for each subsequent request.
  • Input field SearchFilter.industries description changed from Use GICS to pass a list of required industries to Use GICS to pass a list of required industries. Supports filter preset enum values also. e.g. ["ALL/DEFAULT/SYSTEM_DEFAULT"]. Please avoid combination of preset and country codes. e.g. [“DEFAULT“, <SOME_GICS_CODE>]
  • Input field SearchFilter.countries description changed from Use country codes to pass a list of required countries. Country code format is uppercase 2 letter symbol, for example: FI,US,CA For United States (non-US domicile) use US* to Use country codes to pass a list of required countries. Country code format is uppercase 2 letter symbol, for example: FI,US,CA For United States (non-US domicile) use US* Supports filter preset enum values also. e.g. ["ALL/DEFAULT/SYSTEM_DEFAULT"]. Please avoid combination of preset and country codes. e.g. [“DEFAULT“, <COUNTRY_CODE>]
  • Input field SearchFilter.brokers description changed from Use brokers to pass a list of required broker codes to Use brokers to pass a list of required broker codes. Brokers and factset brokers are used separately. They look similar however they are different fields. We do use them as this in every other service and in the FE
  • Field SentimentCountV2.total description changed from count of sentiments including(positive, negative, neutral) for the given company topic @exposed to Count of sentiments including(positive, negative, neutral) for the given company topic @exposed
  • Field SentimentCountV2.positive description changed from no of times topic has been discussed in positive context @exposed to Number of times topic has been discussed in positive context @exposed
  • Field SentimentCountV2.negative description changed from no of times topic has been discussed in negative context @exposed to Number of times topic has been discussed in negative context @exposed
  • Field SentimentCountV2.neutral description changed from no of times topic has been discussed in neutral context @exposed to Number of times topic has been discussed in neutral context @exposed
  • Field originalUrl was added to object type SourceInfo
  • Description The javascript Date as integer. Type represents date and time as number of milliseconds from start of UNIX epoch. on type Timestamp has changed to @tag(name: unauthenticated)
  • Field WebClipperDocumentType.updatedAt has description Last time the document was modified, incl. uploading, sharing, making annotations, etc. Read-only does not affect this timestamp.